Create a conversation
Scope: conversations:write. Give the contact as contact_uuid or, with your own user id, as contact_external_id. Contact and channel (inbox_uuid) must belong to the key's organization and the channel must be active. On a web widget channel the contact sees the conversation once they sign in on your site with identify. The conversation is assigned to the member who created the key. Idempotency-Key is required.
integrationKeyAuthorizationBearer <cf_sk_…>Organization API key (cf_sk_…), created under Organization → API and automations → API keys and sent as Authorization: Bearer cf_sk_….
Idempotency-Key*stringlength <= 200application/json- body
Name the contact by contact_uuid or contact_external_id (the customer's own user id), not both. On a widget inbox a contact with an external id gets its widget identity, so the agent can write first and the signed-in user finds the conversation on the site.
contact_uuid?stringuuidcontact_external_id?stringlength <= 200inbox_uuid*stringuuidsubject*string1 <= length <= 500Success
application/json- response
success*booleandata*meta*curl -X POST 'https://api.getclickfix.com/v1/public-api/conversations' \ -H 'Idempotency-Key: workflow-42-step-1' \ -H 'Content-Type: application/json' \ -d '{ "contact_external_id": "1001", "inbox_uuid": "c2a9d7e4-1f3b-4c5d-8e6f-7a8b9c0d1e2f", "subject": "Delivery question"}'{ "success": true, "data": { "uuid": "8f0e5c2a-6b1d-4f3a-9c7e-2d4b6a8c0e1f", "number": 1042, "status": "open" }, "meta": { "request_id": "01JCK9ZQ3M8R2W7X5E4T1N0PAB" }}