PATCH/v1/comms/messages/{id}/status

Record a message's delivery status

Moves one outbound message to sent, delivered, read, failed or cancelled, stamping delivered_at and read_at the first time each is reached. For a caller holding OUR message id; a device reporting by the carrier's id uses POST /v1/comms/outbound/receipt, which writes the same columns. A word the schema does not know is refused, never quietly stored.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

200application/json

the action's answer

{
  "call": {
    "ai_summary": "string",
    "answered_at": "string",
    "duration_seconds": 1,
    "ended_at": "string",
    "provider": "string",
    "recording_count": 1,
    "recording_url": "string",
    "result": "string",
    "started_at": "string",
    "transcript": "string"
  },
  "content": "string",
  "content_html": "string",
  "conversation_id": 1,
  "delivered_at": "string",
  "delivery": {
    "attempts": 1,
    "claimed_at": "string",
    "claimed_by": "string",
    "error": "string",
    "next_attempt_at": "string",
    "settled_at": "string",
    "state": "string"
  },
  "direction": "string",
  "external_id": "",
  "id": 1,
  "is_deleted": true,
  "medium": "string",
  "occurred_at": "string",
  "parent_message_id": 1,
  "read_at": "string",
  "recorded_at": "string",
  "sender_id": 1,
  "sender_name": "string",
  "sender_type": "string",
  "status": "string",
  "subject": "string",
  "text": {
    "error_code": "string",
    "error_message": "string",
    "media_count": 1,
    "provider": "string",
    "segment_count": 1
  }
}

calloptional

contentstringoptional

content_htmlstringoptional

conversation_idintegeroptional

delivered_atstringoptional

deliveryoptional

directionstringoptional

external_idstringoptional

idintegeroptional

is_deletedbooleanoptional

mediumstringoptional

occurred_atstringoptional

parent_message_idintegeroptional

read_atstringoptional

recorded_atstringoptional

sender_idintegeroptional

sender_namestringoptional

sender_typestringoptional

statusstringoptional

subjectstringoptional

textoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

curl --request PATCH \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/comms/messages/{id}/status' \ --header 'Content-Type: application/json' \ --data '{ "body": { "status": "string" }, "params": { ":id": "string" }, "query": {}}'

{ "call": { "ai_summary": "string", "answered_at": "string", "duration_seconds": 1, "ended_at": "string", "provider": "string", "recording_count": 1, "recording_url": "string", "result": "string", "started_at": "string", "transcript": "string" }, "content": "string", "content_html": "string", "conversation_id": 1, "delivered_at": "string", "delivery": { "attempts": 1, "claimed_at": "string", "claimed_by": "string", "error": "string", "next_attempt_at": "string", "settled_at": "string", "state": "string" }, "direction": "string", "external_id": "", "id": 1, "is_deleted": true, "medium": "string", "occurred_at": "string", "parent_message_id": 1, "read_at": "string", "recorded_at": "string", "sender_id": 1, "sender_name": "string", "sender_type": "string", "status": "string", "subject": "string", "text": { "error_code": "string", "error_message": "string", "media_count": 1, "provider": "string", "segment_count": 1 }}