POST/v1/comms/conversations

Open a conversation with an address

Opens the thread with one address — a medium ("sms", "imessage", "email") and the contact_identifier — or answers the one that already exists. Idempotent on the address, so a caller that cannot remember whether it has written before can simply ask again. Nothing is sent here and nothing names a record.

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.

Request body

application/jsonrequired

bodyoptional

paramsobjectoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "account_identifier": "string",
  "contact_identifier": "string",
  "contact_name": "string",
  "contact_role": "string",
  "created_at": "string",
  "id": 1,
  "is_archived": true,
  "is_muted": true,
  "is_pinned": true,
  "is_starred": true,
  "last_message_at": "string",
  "last_message_direction": "string",
  "last_message_preview": "string",
  "medium": "string",
  "ownerAccountId": "",
  "records": [
    {
      "definition_id": "",
      "definition_key": "string",
      "linked_at": "string",
      "name": "string",
      "row_id": "",
      "status": "string",
      "status_label": "string",
      "status_tone": "string"
    }
  ],
  "subject": "string",
  "unread_count": 1,
  "visibility": "string"
}

account_identifierstringoptional

contact_identifierstringoptional

contact_namestringoptional

contact_rolestringoptional

created_atstringoptional

idintegeroptional

is_archivedbooleanoptional

is_mutedbooleanoptional

is_pinnedbooleanoptional

is_starredbooleanoptional

last_message_atstringoptional

last_message_directionstringoptional

last_message_previewstringoptional

mediumstringoptional

ownerAccountIdstringoptional

recordsarray<>optional

subjectstringoptional

unread_countintegeroptional

visibilitystringoptional

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 POST \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/comms/conversations' \ --header 'Content-Type: application/json' \ --data '{ "body": { "account_identifier": "string", "contact_identifier": "string", "contact_name": "string", "contact_role": "string", "medium": "string" }, "params": {}, "query": {}}'

{ "account_identifier": "string", "contact_identifier": "string", "contact_name": "string", "contact_role": "string", "created_at": "string", "id": 1, "is_archived": true, "is_muted": true, "is_pinned": true, "is_starred": true, "last_message_at": "string", "last_message_direction": "string", "last_message_preview": "string", "medium": "string", "ownerAccountId": "", "records": [ { "definition_id": "", "definition_key": "string", "linked_at": "string", "name": "string", "row_id": "", "status": "string", "status_label": "string", "status_tone": "string" } ], "subject": "string", "unread_count": 1, "visibility": "string"}