Create a conversation

POST /api/v1/client-messages/conversations

Start a new conversation with the advisory firm.

Operation ID: create_conversation_api_v1_client_messages_conversations_post · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: CreateConversationRequest

subject string required: Conversation subject
category ConversationCategory ConversationCategory: Conversation category
message string required: Initial message body

Responses

201 Successful Response

Schema: ConversationDetailResponse

id string required

business_id string required

advisory_firm_id string required

subject string required

category ConversationCategory requiredConversationCategory

status ConversationStatus requiredConversationStatus

created_by_user_id string required

created_by_name string

business_name string

messages array · app__api__v1__schemas__client_messages__MessageResponse app__api__v1__schemas__client_messages__MessageResponse

8 fields

id string required
conversation_id string required
sender_user_id string required
sender_role SenderRole requiredSenderRole
sender_name string
body string required
read_at string · date-time
created_at string · date-time required

created_at string · date-time required

updated_at string · date-time required

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/client-messages/conversations

bash

curl -X POST 'https://api.ondayzero.com/api/v1/client-messages/conversations' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "subject": "string",
  "message": "string"
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/client-messages/conversations', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "subject": "string",
  "message": "string"
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "subject": "string",
  "message": "string"
}

response = httpx.post("https://api.ondayzero.com/api/v1/client-messages/conversations", headers=headers, json=payload)
data = response.json()