Skip to main content

API R20

· 2 min read
Craig Herrington

Release 20 of the API includes 1 new endpoint and 3 changes to an existing endpoints.

Release Date

The UAT API will be updated the on 14-May-2025.

The Live API release date is 21-May-2025.

Times may change without notice, no downtime of the API is expected.

Authentication Token​

CHANGE POST /oauth/token

  • expires_in is now recalculated upon token retrieval from the cache so you can use for token expiry.
View Communications Spec

Communication and Documents​

NEW POST /v1/api/communication-logs/:log-uuid/status

  • This new endpoint will allow recording of the delivery status for each receipient of a communication.

CHANGE POST /v1/api/communications-logs

  • content-recipient-cc field added to supply a comma seperated list of receipients copied in communications.
  • document-template-uuid field added to supply reference to a template originating from Merlin.
  • sender-contact-uuid field added to supply a user's reference for the communication log.
  • error-message field added to supply a user friendly message to explain why a communication failed.
View Formulary Spec

Formulary Management​

CHANGE PATCH /v1/api/:formulary-uuid/dispensing-notes

  • Corrected the patch method to not be destructive to existing notes; The endpoint will now correctly update or append supplied dispensing notes.

CHANGE GET /v1/api/:formulary-uuid/send-to-actions

  • Corrected the GET method to return the uuid values.

If you have any questions please contact us.