PUT
/
actions
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

The ID of the action to update.

Body

application/json
name
string

The name of the action.

description
string | null

The description of the action.

queueBehaviour
enum<string>
default: NO_CHANGE

Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status.

Available options:
REMOVE,
ADD,
NO_CHANGE
filterInQueueIds
string[]

The IDs of the queues the action is available in.

position
enum<string>
default: ALL_QUEUES

Show the action in all queues, selected queues or no queues (to use via API only).

Available options:
ALL_QUEUES,
SOME_QUEUES,
HIDDEN
possibleValues
object[]

The possible values of the action. The user will be prompted to select one of these values when executing the action.

valueRequired
boolean
default: false

Whether the action requires a value to be executed.

freeText
boolean
default: false

Whether the action allows any text to be entered as a value or if it must be one of the possible values.

webhooks
object[]

The action's webhooks.

Response

200 - application/json
id
string
required

The ID of the action.

createdAt
string
required

The date the action was created.

name
string
required

The name of the action.

description
string | null

The description of the action.

queueBehaviour
enum<string>
default: NO_CHANGE

Whether the action resolves and removes the item, unresolves and re-add it to the queue, or does not change the resolve status.

Available options:
REMOVE,
ADD,
NO_CHANGE
filterInQueueIds
string[]

The IDs of the queues the action is available in.

position
enum<string>
default: ALL_QUEUES

Show the action in all queues, selected queues or no queues (to use via API only).

Available options:
ALL_QUEUES,
SOME_QUEUES,
HIDDEN
possibleValues
object[]

The possible values of the action. The user will be prompted to select one of these values when executing the action.

valueRequired
boolean
default: false

Whether the action requires a value to be executed.

freeText
boolean
default: false

Whether the action allows any text to be entered as a value or if it must be one of the possible values.

Was this page helpful?