Update the Attributes of an Action Item

Update the attributes of an existing action item. The API changes only the fields that you include in the request body. The workflow must be a Change, Problem or Request template. SysAid uses the new attributes only in the service records that it creates from the template after this change. If the API returns 500 or 502, read the attributes before you try again. The calling user needs the permission to design workflows.

Path Params
integer
required
1 to 2147483647

The unique identifier of the workflow in SysAid. It is the ID of the SysAid service record that holds the workflow. For a Change, Problem or Request template, this service record is the template's workflow record. For the templates that SysAid ships, this record has the template's ID. A Change, Problem or Request service record holds its own copy of its template's workflow. The read operations also accept the ID of such a service record. If no workflow exists with this ID, for example for the ID of an Incident, the API returns 404.

integer
required
1 to 2147483647

The unique identifier of the action item in SysAid. The action item must belong to the workflow. Use GET /workflows/{workflowId} to retrieve the action items of the workflow.

Body Params

The attributes of the action item to change. Send at least one of these fields. The API keeps the other settings of the action item, for example the e-signature and the assigned Agent. If the account cannot start AI agents from action items, a change removes the AI agent and the Workato recipe of the action item. If SysAid refuses the change, for example because it can start an endless loop of workflows, the API returns 409 with the reason from SysAid. If another user changes the attributes at the same time, the API does not detect it.

integer | null
1 to 2147483647

The ID of the status that SysAid gives the service record when the action item becomes active. The ID must be one of the statuses that the Workflow Designer offers for the type of the template. If the ID is not one of them, the API returns 400 with up to 20 of these statuses. The value "null" means that the action item does not change the status.

integer | null
1 to 2147483647

The ID of the status that SysAid gives the service record when the action item is completed. The ID must be one of the statuses that the Workflow Designer offers for the type of the template. If the ID is not one of them, the API returns 400 with up to 20 of these statuses. The value "null" means that the action item does not change the status.

string | null

The name of the notification that SysAid sends for the action item. The name must be one of the notifications that the Workflow Designer offers for the action item. If the name is not one of them, the API returns 400 with up to 20 of these notifications. The value "null" removes the notification. Do not send "none" to remove it. If the request changes the notification without a "notificationMethod", and the action item has no moment for its notification, the moment becomes "on-active".

string
enum

The moment when SysAid sends the notification. The value "on-active" means that SysAid sends it when the action item becomes active. The value "on-completion" means that SysAid sends it when the action item is completed. The action item must have a notification after the change.

Allowed:
boolean

Whether the action item completes itself. An action item that requires an e-signature cannot complete itself. If you send "true" for such an action item, the API returns 409.

boolean

Whether SysAid cancels the notification that it sends when the action item's Assigned To changes. This setting does not cancel the notification that SysAid sends when the action item becomes active or is completed.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json