Skip to content

Update Sequence

PATCH
/sequences/{sequence_id}

Update sequence metadata. Rejects PATCH when status is transitional (409).

Authorizations

Parameters

Path Parameters

sequence_id
required

Sequence ID

string

Sequence ID

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
appointment_id
Any of:
integer
description
Any of:
string
finish_on_reply
Any of:
boolean
is_shared
Any of:
boolean
name
Any of:
string
schedule_id
Any of:
string
send_in_same_thread
Any of:
boolean
textual_agent_name
Any of:
string
voice_agent_name
Any of:
string
wait_for_new_contacts
Any of:
boolean

Responses

200

Successful Response

object
data
required
object
contacts_affected
integer
sequence_id
required
string
status
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string