Skip to main content

Changelog

All notable changes to the Qlara Platform API are documented on this page. Each release is listed with its version number, date, and a summary of what was added, changed, improved, or fixed.

We follow Semantic Versioning: MAJOR.MINOR.PATCH.

  • MAJOR -- breaking changes that require client updates.
  • MINOR -- new features and endpoints, backward-compatible.
  • PATCH -- bug fixes and minor improvements.

v1.4.0 -- September 2026​

Added​

  • X-Request-Id response header: every response now carries the trace identifier the platform assigned to the request, on errors too. Quote it when contacting support about a specific call.

Changed​

  • Normalised delivery statuses: every delivery-tracking endpoint reports one deliveryStatus set, ACCEPTED, REJECTED, DELIVERED, EXPIRED, DELETED, UNDELIVERABLE, ERROR, DISABLED, UNSUPPORTED, CONVERSATION_CLOSED and UNKNOWN, with lowercase descriptions (delivered, undeliverable, general error, ...). The delivery-status webhook sends the same numeric codes as statusCode. SENT and RECEIVED are no longer returned. See Delivery Statuses.
  • Refused sends: POST /api/partner-gateway/v1/sms/messages, /rcs/messages and /whatsapp/messages answer 422 with a JSend fail body, instead of 202, when the messaging platform refuses the message. 202 is still returned when a fallback channel accepted it.

Fixed​

  • Message history date parameters: GET /api/partner-gateway/v1/messages/history accepts from and to as a date (2026-08-27, the whole UTC day), a date-time without offset (read as UTC) or ISO 8601 with offset. A value in another shape, or a from later than to, is answered 400 with the accepted formats instead of a bare 404.
  • Channel parameter: channel is read case-insensitively on the history and delivery-status endpoints, and an unknown value is answered 400 instead of 404.
  • Inbox message detail: GET /api/partner-gateway/v1/inbox/conversations/{chatId}/messages no longer fails with 500.
  • SMS delivery status: SMS messages are no longer reported as UNKNOWN. An SMS still in flight reads ACCEPTED, and its final status follows once the carrier receipt arrives.

Documentation​

  • Rate limits: the X-RateLimit-* headers and the per-plan table were never implemented and have been removed. The messaging endpoints apply a per-account requests-per-second limit answered with 429 and Retry-After; the Platform endpoints apply none. See API Overview.
  • Pagination: collections are page-based (page from 0, limit) and return data, page, limit, totalCount and totalPages. The previously documented offset/pagination shape never existed; the endpoints that return a plain array are listed on the API Overview.
  • Error bodies are now documented in their real JSend shape, and the export flow of the message-history use case follows the real endpoints.
  • Webhooks: the webhook guides now show the real management responses (201 with companyId and callbackUrl, 409 when a webhook already exists, 204 on delete), the real DELIVERY, READ and INBOUND payloads, and the real retry policy.

v1.3.0 -- May 2026​

Added​

  • Conversation assignment: assign and remove the assignee of an inbox conversation, and list assignable team members of your company.
    • GET /api/partner-gateway/v1/inbox/conversations/{chatId} -- get a single conversation, including its current assignee.
    • POST /api/partner-gateway/v1/inbox/conversations/{chatId}/assignee -- assign a conversation to a team member of your company.
    • DELETE /api/partner-gateway/v1/inbox/conversations/{chatId}/assignee -- remove the assignee from a conversation.
    • GET /api/partner-gateway/v1/inbox/conversations/assignable-users -- list users that can be assigned to conversations.
  • Inbox section filter: new optional section query parameter on GET /api/partner-gateway/v1/inbox/conversations to narrow results by assignment state.

v1.2.0 -- April 2026​

Added​

  • Social Profiles endpoints: retrieve connected social media accounts linked to your Qlara account.
    • GET /api/partner-gateway/v1/socials -- list all connected social profiles (Facebook, Instagram, LinkedIn, Google, TikTok).
    • GET /api/partner-gateway/v1/socials/{platform} -- get profile details for a specific platform.
  • Multi-language documentation: the developer portal is now available in English and Italian. Switch locale from the navigation bar.
  • Postman Collections: downloadable .json collections for every API group (Qlara Platform, SMS Universal, SMS Legacy, RCS Send, RCS Templates, WhatsApp). Import into Postman and start testing immediately.
  • SDK & Libraries page: quick integration examples for Node.js, Python, PHP, Java, Go, and C#.

Improved​

  • Developer portal redesign: updated documentation site with Mermaid sequence diagrams, code tabs for multi-language examples, and an FAQ accordion for faster navigation.
  • API Overview page: added comprehensive documentation for rate limits, pagination, error handling, and retry strategies.

v1.1.0 -- March 2026​

Added​

  • Inbox conversations: full conversation management for inbound messages.
    • GET /api/partner-gateway/v1/inbox -- list all conversations with filtering and pagination.
    • GET /api/partner-gateway/v1/inbox/{conversationId} -- get a single conversation with message history.
    • POST /api/partner-gateway/v1/inbox/{conversationId}/reply -- reply to a conversation.
    • POST /api/partner-gateway/v1/inbox/{conversationId}/archive -- archive a conversation.
    • POST /api/partner-gateway/v1/inbox/{conversationId}/read -- mark a conversation as read.
  • Media management: upload and manage media files for use in RCS and WhatsApp messages.
    • POST /api/partner-gateway/v1/media -- upload a media file (image, video, document, audio).
    • GET /api/partner-gateway/v1/media -- list uploaded media with filtering by type and date.
    • DELETE /api/partner-gateway/v1/media/{mediaId} -- delete an uploaded media file.

Improved​

  • Webhook documentation: added detailed payload examples for all webhook event types (delivery, read receipt, inbound message, campaign status).
  • Error responses: all error responses now include a path field indicating the endpoint that returned the error.

Fixed​

  • Fixed an issue where offset values greater than total returned a 500 error instead of an empty data array.
  • Fixed inconsistent timestamp formats in campaign status responses (now all ISO 8601 UTC).

v1.0.0 -- February 2026​

Added​

  • SMS messaging:
    • POST /api/message-server/sms/send -- send SMS using the modern universal format (single recipient, placeholder support).
    • POST /api/message-server/sms/legacy/send -- send SMS using the legacy format (multi-recipient in a single request).
    • Unicode detection and automatic message part calculation.
  • RCS messaging:
    • POST /api/message-server/rcs/send -- send RCS messages (text, card, carousel).
    • GET /api/message-server/rcs/templates -- list available RCS templates.
    • POST /api/message-server/rcs/templates -- create a new RCS template.
    • PUT /api/message-server/rcs/templates/{id} -- update an existing RCS template.
    • DELETE /api/message-server/rcs/templates/{id} -- delete an RCS template.
    • Interactive suggestions: reply, open URL, call, location, calendar event.
    • Automatic fallback to WhatsApp and/or SMS when the recipient does not support RCS.
  • WhatsApp messaging:
    • POST /api/message-server/whatsapp/send -- send WhatsApp messages (text, image, video, audio, document, location, sticker, reaction).
    • GET /api/message-server/whatsapp/templates -- list approved WhatsApp templates.
    • GET /api/message-server/whatsapp/phone-numbers -- list registered WhatsApp phone numbers.
    • Template messages with buttons, media headers, and tracked links.
    • Automatic fallback to RCS and/or SMS.
  • Contacts & Lists management:
    • GET /api/partner-gateway/v1/contacts -- list contacts with search and filtering.
    • POST /api/partner-gateway/v1/contacts -- create a new contact.
    • PUT /api/partner-gateway/v1/contacts/{id} -- update a contact.
    • DELETE /api/partner-gateway/v1/contacts/{id} -- delete a contact.
    • GET /api/partner-gateway/v1/lists -- list contact lists.
    • POST /api/partner-gateway/v1/lists -- create a new contact list.
    • POST /api/partner-gateway/v1/lists/{id}/contacts -- add contacts to a list.
    • DELETE /api/partner-gateway/v1/lists/{id}/contacts -- remove contacts from a list.
  • Campaign management:
    • GET /api/partner-gateway/v1/campaigns -- list campaigns with status filtering.
    • POST /api/partner-gateway/v1/campaigns -- create a new campaign.
    • GET /api/partner-gateway/v1/campaigns/{id} -- get campaign details and delivery statistics.
    • PUT /api/partner-gateway/v1/campaigns/{id} -- update a draft campaign.
    • DELETE /api/partner-gateway/v1/campaigns/{id} -- delete a draft campaign.
    • POST /api/partner-gateway/v1/campaigns/{id}/send -- launch a campaign.
    • Scheduling support: send immediately or at a specified date and time.
  • Delivery tracking & Webhooks:
    • GET /api/partner-gateway/v1/messages/status -- check message delivery status.
    • GET /api/partner-gateway/v1/webhooks -- list configured webhook endpoints.
    • POST /api/partner-gateway/v1/webhooks -- register a new webhook endpoint.
    • PUT /api/partner-gateway/v1/webhooks/{id} -- update a webhook endpoint.
    • DELETE /api/partner-gateway/v1/webhooks/{id} -- delete a webhook endpoint.
    • Events: delivery confirmation, read receipt, inbound message, campaign completed.
    • HMAC signature verification for webhook payloads.
  • Export system:
    • POST /api/partner-gateway/v1/exports -- request an async data export (contacts or delivery reports).
    • GET /api/partner-gateway/v1/exports/{id} -- check export status and download link.
    • Export formats: CSV and XLSX.
  • Subscription & Billing:
    • GET /api/partner-gateway/v1/subscription -- get current plan details and credit balance.
  • Authentication: API Key (X-Api-Key header) and Basic Auth (Authorization: Basic header).
  • Rate limiting: 1,000 requests/min for production keys, 100 requests/min for trial keys.
  • Pagination: offset/limit pattern on all collection endpoints (default limit: 20, max: 100).
Info

For questions about any release, contact our developer support team or visit the FAQ.