/v1/comms/conversations/{id}/messagesRead a conversation's messages
The messages of one conversation, in order, both directions, with context: the linked records and their facts, board_goal and customer_goal, and campaigns — the blasts whose copies were sent in this thread, each with the message this contact received, the goal its author set and whether they have replied. Read this before replying to or summarising a thread; when the contact is answering a campaign, its goal says what the reply should move them toward. board_goal is the linked board's or page's purpose (patch_boards_id sets a board's) and customer_goal the record's own column labelled Goal, Neo goal, Customer goal or Relationship goal. The most specific goal leads: the customer's, then the campaign's being answered, then the board's.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"context": {
"campaigns": [
{
"blast_id": "",
"goal": "string",
"kind": "string",
"message": "string",
"name": "string",
"replied": "string",
"sent_at": "string"
}
],
"messages": [
{
"at": "string",
"body": "string",
"direction": "string",
"id": 1.5,
"no_advertising": true,
"source_provider": "string"
}
],
"other_channels": [
"string"
],
"profile": [
"string"
],
"records": [
{
"board": "string",
"board_goal": "string",
"customer_goal": "string",
"definition_key": "string",
"facts": [
{
"label": "string",
"value": "string"
}
],
"name": "string",
"row_id": "",
"tag_column_id": ""
}
]
},
"messages": [
{
"call": {
"ai_summary": "string",
"answered_at": "string",
"duration_seconds": "string",
"ended_at": "string",
"provider": "string",
"recording_count": "string",
"recording_url": "string",
"result": "string",
"started_at": "string",
"transcript": "string"
},
"content": "string",
"conversation_id": 1.5,
"delivery": {
"attempts": "string",
"claimed_at": "string",
"claimed_by": "string",
"error": "string",
"next_attempt_at": "string",
"settled_at": "string",
"state": "string"
},
"direction": "string",
"id": 1.5,
"is_deleted": true,
"medium": "string",
"no_advertising": "string",
"occurred_at": "2026-01-01T00:00:00Z",
"recorded_at": "2026-01-01T00:00:00Z",
"sender_name": "string",
"sender_type": "string",
"source_provider": "string",
"status": "string",
"text": {
"error_code": "string",
"error_message": "string",
"media_count": 1.5,
"provider": "string",
"segment_count": 1.5
}
}
]
}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"
}