Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Conversation

Create a new conversation account

Creates a new conversation account and returns its details.

post/conversation_accounts

Request body

type'line' | 'sms' | 'whatsapp' required

Type of the account.

namestring required
detailstring required
secretstring required
tokenstring required
message_flow_idstring uuid

Example request

{
  "type": "sms",
  "provider_data": {
    "phone_number_id": "1234567890123456",
    "app_secret": "abc123def456...redacted..."
  }
}

Response

idstring uuid

The unique identifier of the conversation account.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

type'line' | 'sms' | 'whatsapp'

Type of the account.

namestring

Name of the account.

detailstring

Detailed information about the account.

secretstring

Webhook secret for signature verification. Write-only.

tokenstring

API token for the messaging platform. Write-only.

message_flow_idstring uuid

The flow ID to execute when a message is received on this account. Returned from the GET /flows response.

tm_createstring date-time

Timestamp when the account was created.

tm_updatestring date-time

Timestamp when the account was last updated.

tm_deletestring date-time

Timestamp when the account was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "type": "sms",
  "name": "Main SMS Account",
  "detail": "Primary SMS messaging account",
  "secret": "whsec_...redacted...",
  "token": "xoxb_...redacted...",
  "provider_data": {
    "phone_number_id": "1234567890123456",
    "app_secret": "abc123def456...redacted..."
  },
  "message_flow_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}