Allo

Execute conversation action

Execute an action on a conversation.

PUT/v2/api/conversations/{contact_number}/action

Available actions

ActionEffect
READMark the conversation as read
UNREADMark the conversation as unread
ARCHIVEArchive the conversation and mark all items as read
UNARCHIVEUnarchive the conversation

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.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

contact_numberstringrequired

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

Body

actionenum<string>required

The action to execute.

READUNREADARCHIVEUNARCHIVE

allo_numberstring

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

Responses

200Action executed successfully
401
404
429