Skip to navigation

Update ticket workflow

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the ticket workflow, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
display_namestringOptional>=1 character
A readable name for the workflow.
conditional_actionslist of objectsOptional
Groups of actions that run when their condition matches.
default_actionobjectOptional
The actions that run when no conditional action matches.

Response

The updated ticket workflow, at its new version
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
display_namestringOptional>=1 character
A readable name for the workflow.
connector_idstringOptional

The connector this workflow’s actions run against. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

conditional_actionslist of objectsOptional
Groups of actions that run when their condition matches.
default_actionobjectOptional
The actions that run when no conditional action matches.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error