Changelog
Dated entries, newest first. Anything that would break an existing integration is called out explicitly.
Additions are not breaking: a new field on a response, a new optional parameter, a new enum member, or a new endpoint. Build clients that ignore fields they do not recognise and tolerate unknown enum values, and these land without your involvement.
2026-11-12: Buttons and lists
Section titled “2026-11-12: Buttons and lists”Added
interactiveonPOST /messages: up to three reply buttons, or a list of up to ten rows, inside the customer’s 24-hour service window. See sending buttons or a list.buttonReplyon every message: theidandtitleof the button or row a customer tapped, andnullon every other message.
2026-11-12: Sending a file
Section titled “2026-11-12: Sending a file”Added
mediaonPOST /messages: a photo, document, video or voice note by public HTTPS link, inside the customer’s 24-hour service window. See sending a file.
Fixed
GET /messages/{id}now givesfailureReasonfor a failed free-text reply or file. It was alwaysnullfor a message sent straight into a conversation.
2026-11-12: Files in conversations
Section titled “2026-11-12: Files in conversations”Added
mediaon every message: each file’sindex,type,mimeType,fileName,sizeBytes,caption,status,urlanddownloadPath. Webhooks formessage.receivedandmessage.sentcarry it too.GET /conversations/{id}/messages/{messageId}/media/{index}downloads a file the customer sent. Needs read:conversations.- The
media_not_readyproblem code, answered with409while a file is still being saved.
Changed
richContent.mediano longer includesstorageKey. It was a path inside tkana’s private storage and could not be used to fetch anything. Read files frommedia. See files in conversations.
2026-10-24: Files on tickets
Section titled “2026-10-24: Files on tickets”Added
POST /tickets/{id}/filesuploads a file of up to 10 MB to a ticket asmultipart/form-data. Needs write:tickets.GET /tickets/{id}/files/{fileId}downloads it. Needs read:tickets.fileson every ticket response: each file’sid,name,typeandsize. It also lists the files staff uploaded in the portal and the files a customer sent over WhatsApp with the request the ticket was filed from.- The
payload_too_largeproblem code, answered with413.
Notes
- A file has no URL, in any response. It is read only through the download endpoint, with a key that may read tickets. See files on tickets.
attachmentsis unchanged and still holds links only.
2026-10-01: Pipelines and stages on customers
Section titled “2026-10-01: Pipelines and stages on customers”Added
GET /customer-pipelineslists the organization’s customer pipelines, the entry pipeline first, each with its stages in board order. A stage has anid, anameand thelifecycleit counts as. Needs read:customers.lifecycleon every customer response:lead,qualified,customer,lost,churned, ornullwhen no stage has set it yet.pipelineson every customer response: one entry per pipeline the contact is in, withpipelineId,pipeline,stageId,stage,stageLifecycleandenteredAt. It is a list, so an organization adding a second pipeline does not change its shape.GET /customers?lifecycle=leadlists only contacts with that lifecycle.stageonPOST /customersandPATCH /customers/{id}: a stage id fromGET /customer-pipelines. The contact’s card in that pipeline moves there. A contact who is not in that pipeline enters it at that stage.- The
customer.stage_changedwebhook, sent once per move of a contact to another stage, whoever made it: staff, the AI agent, a workflow or an API write.dataholds the customer, the pipeline,fromStage,toStageandmovedAt.
Notes
- A stage the organization does not have is refused with
422, with one entry inerrorsnamingstage, and nothing in the request is written. A refusedPOSTcreates no customer. - A contact created without a
stageenters the first stage of the entry pipeline. - Pipelines and stages are edited in the portal, by the organization’s owners. The API reads them and never changes them.
2026-09-30: Custom fields on customers
Section titled “2026-09-30: Custom fields on customers”Added
GET /customer-fieldslists the fields the organization’s owners defined for its customers: each field’skey, labels,type,requiredflag and, for aselect, its options. Needs read:customers.customFieldson every customer response, keyed by field key. A field with no value is absent. A date isYYYY-MM-DDand aselectholds the option’s key, not its label.customFieldsonPOST /customersandPATCH /customers/{id}. It is a merge: a key sets that field,nullor""clears it, and fields you leave out keep their values.
Notes
- A key the organization has not defined, or a value of the wrong type, is refused with
422. Each entry inerrorsnames the field ascustomFields.<key>, and nothing in the request is written. A refusedPOSTcreates no customer. - A required field that holds a value cannot be cleared.
- Fields are created and changed in the portal, by the organization’s owners. The API reads them and never changes them.
2026-09-22 — Reads for tickets, bookings and services
Section titled “2026-09-22 — Reads for tickets, bookings and services”Added
GET /tickets,/tickets/{id}and/tickets/{id}/history. Filter bystatus,priority,categoryandcustomerId;searchmatches the subject and description by substring and a reference (T-…or the pipeline card’sTK-…) exactly.GET /bookingsand/bookings/{id}, with inclusivefrom/today bounds.GET /services,/services/{id}/resources, and/services/{id}/resources/{resourceId}/availability. Availability accepts at most 31 days per request.cursoron the customers, conversations, tickets and bookings lists, so a sync can page without risking skipped rows.- This documentation site. The reference is generated from the running API, so it cannot describe an endpoint that does not exist or miss one that does.
Notes
- A booking’s
date,startTimeandendTimeare the organization’s local wall clock, not instants. Availability slots are instants. - A sync reports creations and changes, not removals. See syncing.
2026-09-19 — Reads for customers and conversations
Section titled “2026-09-19 — Reads for customers and conversations”Added
GET /customersand/customers/{id}.GET /conversations,/conversations/{id}and/conversations/{id}/messages, with the AI summary on a resolved conversation once it has been written.- Organization API keys with scopes, created by owners and admins in the portal.
application/problem+jsonerrors carrying a stablecode, andX-Request-Idon every response.