Skip to main content
PUT
Execute conversation action
Required scope: CONVERSATIONS_WRITE

Available actions

Passing an unsupported action returns a 400 error with code INVALID_ACTION.

Idempotency

All actions are idempotent — calling READ on an already-read conversation is a no-op and returns 200. This endpoint also supports the Idempotency-Key header. See Idempotency.

Scoping to a line

Omit allo_number to apply the action across all Allo numbers. Provide it to scope the action to a specific line.

Authorizations

Authorization
string
header
required

Path Parameters

contact_number
string
required

The external phone number in E.164 format. URL-encode the + as %2B.

Example:

"+14155551234"

Body

application/json
action
enum<string>
required

The action to execute.

Available options:
READ,
UNREAD,
ARCHIVE,
UNARCHIVE
allo_number
string

Scope the action to a specific Allo number (E.164). Without this, the action applies across all lines.

Example:

"+14155550100"

Response

Action executed successfully