Skip to main content
POST
/
conversations
Create conversation
curl --request POST \
  --url https://api.weav.com/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "email",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subject": "<string>",
  "status": "open",
  "priority": "low",
  "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_type": "user"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "email",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subject": "<string>",
  "status": "open",
  "priority": "low",
  "assignee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignee_type": "user",
  "closed_at": "2023-11-07T05:31:56Z",
  "first_response_at": "2023-11-07T05:31:56Z",
  "last_message_at": "2023-11-07T05:31:56Z",
  "is_spam": true,
  "spam_score": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Workspace API token. Include abilities external-api:read and/or external-api:write.

Body

application/json
​
channel
enum<string>
required
Available options:
email,
chat
​
customer_id
string<uuid>
required
​
subject
string | null
Maximum string length: 500
​
status
enum<string> | null
Available options:
open,
closed
​
priority
enum<string> | null
Available options:
low,
normal,
high,
urgent
​
assignee_id
string<uuid> | null

User or agent UUID to assign. Set null to unassign. Must belong to the same workspace. For chat, agent assignment is limited to the conversation's original chat agent. For email, agent assignment is limited to the workspace active email agent.

​
assignee_type
enum<string> | null
Available options:
user,
agent

Response

Conversation created

​
id
string<uuid>
​
channel
enum<string>
Available options:
email,
chat
​
customer_id
string<uuid>
​
subject
string | null
​
status
enum<string>
Available options:
open,
closed
​
priority
enum<string>
Available options:
low,
normal,
high,
urgent
​
assignee_id
string<uuid> | null

User or agent UUID to assign. Must belong to the same workspace. For chat, agent assignment is limited to the conversation's original chat agent. For email, agent assignment is limited to the workspace active email agent.

​
assignee_type
enum<string> | null
Available options:
user,
agent
​
closed_at
string<date-time> | null
​
first_response_at
string<date-time> | null
​
last_message_at
string<date-time> | null
​
is_spam
boolean
​
spam_score
number | null
​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null