Skip to main content
PUT
/
v2
/
api
/
conversations
/
{contact_number}
/
action
Execute conversation action
curl --request PUT \
  --url https://api.withallo.com/v2/api/conversations/{contact_number}/action \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "READ",
  "allo_number": "+14155550100"
}
'
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}
Required scope: CONVERSATIONS_WRITE

​
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.

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