Skip to main content
PUT
Update a Request

Usage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uid
string
required

The UID (or friendly_id) of the request

Body

application/json

Request body for updating a Request. Pass UIDs (not objects) for relationship fields.

title
string
deprecated

please use "title_markdown" instead

description
string | null
deprecated

please use "description_markdown" instead

title_markdown
string

The title of the Request, as markdown. Takes precedence over title when both are provided.

description_markdown
string | null

The description of the Request, as markdown. Takes precedence over description when both are provided.

priority
enum<string>
Available options:
low,
medium,
high,
urgent
status
enum<string>
default:open

Request status

Available options:
open,
in_progress,
waiting,
resolved,
archived
assignee_admin
string | null

The admin user assigned to this request. Pass the UID of the related object.

assignee_inbox
string | null

The team inbox assigned to this request. Pass the UID of the related object.

target
string | null

Service associated with this request. Pass the UID of the related object.

tags
string[] | null

Tags associated with this request. Pass an array of UIDs of the related objects.

associated_apps
string[] | null

Apps associated with this request. Pass an array of UIDs of the related objects.

associated_equipments
string[] | null

Equipment associated with this request. Pass an array of UIDs of the related objects.

custom_form_inputs
(Arbitrary input (by label) · object | Native input (by uid) · object)[] | null

Custom forms attached to this request

A custom form input item for request creation. Either "label" (arbitrary input) or "uid" (native input from service configuration) must be provided.

Response

200 - application/json

Successful

result
object