Skip to main content

Changelog

All notable changes to the Zentake API are documented here.

The format is based on Keep a Changelog. Entries are grouped by date and tagged by the affected endpoint. Only changes that affect how you integrate, endpoints, request/response fields, headers, access, and webhook payloads, are listed.

Versioning. Routes are served under /<version>/, with v2 as the default. Some response formats can be opted into per request with the X-API-VERSION header (current: v2.1).

[2026-08-18]​

Fixed​

  • /messages. Sending a reminder no longer creates a separate message. A reminder now re-sends the original link on the patient's existing message, and the send is recorded in that message's reminders history. Previously a reminder created a standalone message with its own new link that did not resolve to any response, so patients opening it saw "Form not available".

Changed​

  • /messages. message_type: "reminder" now requires exactly one of response or packet_response identifying the outstanding response. Requests without a parent reference are rejected with 400. form, packet, and document are ignored for reminders.
  • /messages. When a reminder omits preferred_delivery_method, the channel is taken from whichever contact override you send: target_phone alone means SMS, target_email alone means email. A reminder whose channel has no destination to send to (for example sms with no phone number anywhere on the patient or the message) is rejected with 400 instead of being accepted and silently never delivered.

[2026-06-27]​

Added​

  • /export-csv. New opt-in export format via the X-API-VERSION: v2.1 header. It returns a single flat table where questions follow the form order (page → section → row → question), every table row is expanded into its own columns, answers from repeated blocks are joined with ; , and confirmation checkboxes are exported as confirmed when checked (blank otherwise). Requests without the header keep the previous export format unchanged.

[2026-05-12]​

Changed​

  • /export-csv. The export payload now identifies the customer with a customer_public_id field, replacing the previous internal customer_id. Update any integration that reads the customer id from an export.

[2026-02-20]​

Changed​

  • All endpoints. API access now requires the API feature to be enabled for your organization. Previously the endpoints were open; requests from organizations without the feature are now rejected.

[2026-02-18]​

Added​

  • /responses. New include_answers query parameter. When set, the response payload includes the full list of submitted answers instead of just the response metadata.

[2026-01-20]​

Added​

  • /questions. Questions now expose a button_text value.

[2025-12-27]​

Changed​

  • /patients, /messages, /export-csv. The customer is now identified by a stable public id across these endpoints, instead of the previous internal numeric id. Update any integration that stored the old identifier.

[2025-12-22]​

Added​

  • /messages. New scheduled-messages support: list, retrieve, and update messages scheduled for future delivery, with filtering by message and patient.

[2025-12-01]​

Added​

  • API sandbox. A sandbox mode is available for testing integrations, with its own usage limits, so you can exercise the API without affecting live data.

[2025-11-28]​

Added​

  • /webhooks. Webhook events are now emitted for patient changes, in addition to the existing document and response events.

[2025-11-10]​

Changed​

  • /webhooks. The packet-response webhook payload now includes created_at, updated_at, form_index, is_queued, and a responses list containing the ids of each response in the packet. The pdf_file field was removed from this payload.

[2025-10-01]​

Added​

  • /patients. Patients now support tags and custom fields in both requests and responses.

[2025-07-25]​

Added​

  • /responses, /packets. New endpoints to download a submitted response and a submitted packet response.

[2025-05-10]​

Added​

  • /messages. New messaging endpoints to create, read, update, and delete messages sent to patients.

[2025-05-06]​

Added​

  • /webhooks. New endpoint to send a test webhook event, so you can verify your receiver before going live.

[2025-04-10]​

Added​

  • /webhooks. Webhook support: register endpoints to receive event notifications, with signed payloads you can verify on your side.
  • /documents. Document responses now include an input_fields list describing each fillable field on the document.

[2025-03-14]​

Added​

  • /patients. Patients now support a preferred_contact value.

[2025-03-03]​

Added​

  • Initial v2 API. First public release: manage patients, retrieve responses and forms, work with packets and documents, and export answers to CSV.