Create a conversation
Starts a new conversation for an existing visitor in the current organization.
/api/conversationsStarts a new conversation for an existing visitor in the current organization. Widget callers should use the visitor identity returned during widget bootstrap and first create the visitor record with POST /api/tracking/visitors/track. Operators can also create a conversation for an existing visitor. The optional channel field identifies where the conversation started, such as web, email, or api. New conversations start with AI enabled and then run assignment and routing rules.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
conversations:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Non-idempotent: Repeating this request may create duplicate work or side effects. After an ambiguous timeout, check the resource state before retrying.
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
Conversation fields supplied in the request.
TypeScript Definitions
Use the request body type in TypeScript.
Conversation fields supplied in the request.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "9f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "organizationId": "8a8f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "projectId": "11111111-1111-4111-8111-111111111111", "projectName": "Example name", "visitorId": "550e8400-e29b-41d4-a716-446655440000", "operatorId": null, "status": "open", "priority": "normal", "source": "widget", "aiEnabled": true, "locale": "en", "localeSource": "organization_default", "localeLocked": false, "localeUpdatedAt": null, "title": null, "messageCount": 0, "hasUnreadMessages": false, "tags": [], "customFields": {}, "languageConfidence": 1, "languageSource": "manual", "translationActive": true, "translationTargetLanguage": "example", "createdAt": "2026-06-23T08:00:00.000Z", "updatedAt": "2026-06-23T08:00:00.000Z"}Request examples
curl
curl --request POST \
'https://api.convor.io/api/conversations' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"visitorId": "550e8400-e29b-41d4-a716-446655440000",
"channel": "web"
}'JavaScript
const response = await fetch("https://api.convor.io/api/conversations", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"visitorId": "550e8400-e29b-41d4-a716-446655440000",
"channel": "web"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?