API ReferenceConversations
Create conversation
Required scope: `conversations:write`, `actor=self`.
Authorization
bearerAuth AuthorizationBearer <token>
OAuth access token, e.g. Authorization: Bearer swot_….
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/oauth/v1/conversations" \ -H "Content-Type: application/json" \ -d '{ "customer_email": "user@example.com", "initial_message": "string" }'{
"data": {
"id": "string",
"inserted_at": 0,
"initial_message": "string",
"is_spam": true,
"last_message": "string",
"last_message_inserted_at": 0,
"status": "string",
"user": {
"id": "string",
"name": "string",
"email": "string",
"instagram_handle": "string",
"profile_picture_url": "string"
},
"pinned": true,
"unread_count": 0,
"summary": "string",
"meta_info": {},
"guest_submission": true,
"group_id": "string",
"group": {
"id": "string",
"name": "string",
"slug": "string",
"color": "string"
},
"conversation_assignee": {
"id": "string",
"conversation_id": "string",
"user_id": "string",
"assignor_id": "string",
"assigned_at": 0
}
}
}{
"error": "insufficient_scope",
"error_description": "The token is missing a required scope."
}