Update Work Routine

PATCH

/work/routines/{routine_id}

• Production
• QA

Change one routine.

Only somebody who can read the routine’s delivery conversation may change it, and re-pointing deliveryConversationId is a second grant: the NEW conversation must be readable too. Omitted fields keep their stored value.

Authorizations

• BearerAuth

Parameters

Path Parameters

routine_id

required

Routine id

string format: uuid

Routine id

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Changes to one routine. Omitted fields keep their stored value.

object

agentId

Any of:

string

string

null

null

deliveryConversationId

Any of:

string

string

null

null

enabled

Any of:

boolean

boolean

null

null

eventPolicy

Any of:

object

object

key

additional properties

any

null

null

instruction

Any of:

string

string

null

null

localTime

Any of:

string

string

null

null

timezone

Any of:

string

string

null

null

title

Any of:

string

string

null

null

trigger

Any of:

object

object

key

additional properties

any

null

null

triggerKind

Any of:

string

string

null

null

weekdays

Any of:

Array<integer>

Array<integer>

null

null

Responses

200

Successful Response

object

data

required

One routine, as the create and update operations return it.

object

routine

required

The routine as stored after the write

object

agentId

Any of:

string

string

null

null

deliveryConversationId

Any of:

string

string

null

null

enabled

Any of:

boolean

boolean

null

null

id

Any of:

string

string

null

null

instruction

Any of:

string

string

null

null

lastRunAt

Any of:

string

string

null

null

lastStatus

Any of:

string

string

null

null

localTime

Any of:

string

string

null

null

timezone

Any of:

string

string

null

null

title

Any of:

string

string

null

null

triggerKind

Any of:

string

string

null

null

weekdays

Any of:

Array<integer>

Array<integer>

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string