İçeriğe geç
Dokümantasyon
Api reference

Konuşmalar

Konuşma oluşturma, okuma, güncelleme; mesaj ve iç not ekleme.

Konuşmaları listele

GET
/v1/public-api/conversations

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Query Parameters

limit?integer
Range0 <= value <= 100
Default20
offset?integer
Range0 <= value
Default0

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X GET 'https://api.getclickfix.com/v1/public-api/conversations'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}

Konuşma oluştur

POST
/v1/public-api/conversations

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Request Body

application/json
  1. body
contact_uuid*string
Formatuuid
inbox_uuid*string
Formatuuid
subject*string
Length1 <= length <= 500

Response Body

Success

application/json
  1. response
success*boolean
data*
meta*
Example Request
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_uuid": "00000000-0000-4000-8000-000000000001",  "inbox_uuid": "00000000-0000-4000-8000-000000000001",  "subject": "API support request"}'
Example Response
{  "success": true,  "data": {    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",    "number": 0,    "status": "string"  },  "meta": {    "request_id": "string"  }}

Konuşmayı getir

GET
/v1/public-api/conversations/{uuid}

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Path Parameters

uuid*string
Formatuuid

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X GET 'https://api.getclickfix.com/v1/public-api/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}

Konuşmayı güncelle

PATCH
/v1/public-api/conversations/{uuid}

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Path Parameters

uuid*string
Formatuuid

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Request Body

application/json
  1. body
status?ConversationStatus
Value in"open""pending""snoozed""resolved""closed"
priority?ConversationPriority
Value in"low""normal""high""urgent"
subject?string
Lengthlength <= 500
assignee?|
Formatuuid
team?|

Team uuid; null removes the team (tenant.conversations.assign)

Formatuuid
snoozed_until?string
Formatdate-time

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X PATCH 'https://api.getclickfix.com/v1/public-api/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}

Mesajları listele

GET
/v1/public-api/conversations/{uuid}/messages

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Path Parameters

uuid*string
Formatuuid

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X GET 'https://api.getclickfix.com/v1/public-api/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}

Mesaj veya iç not ekle

POST
/v1/public-api/conversations/{uuid}/messages

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Path Parameters

uuid*string
Formatuuid

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Request Body

application/json
  1. body
content*string
private?boolean
client_id?string
Formatuuid

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X POST 'https://api.getclickfix.com/v1/public-api/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "content": "string"}'
Example Response
{  "success": true,  "data": null,  "meta": {    "request_id": "string"  }}