We’re happy to announce that the new and improved REST API version is now available and will replace the old version. This means you’ll need to update to the new version, as you won’t be able to use the old version after 30.09.2025.
What do I need to do then?
If you are using our REST API, you will have to update the base URL or the API.
Version 1 (old): https://restapi-nor.leaddesk.com/stable/
Version 2 (new): https://restapi-nor.leaddesk.com/v2/
Please note that the API refers to your environment's zone in the base URL, seen above as "nor".
If you are unsure about which zone you are in, please review your Administrator panel > Settings > API, or reach out to our Support.
What is different in the new version?
The new version has been kept mostly as it was for backwards compatibility reasons, but certain fields and behaviors in the API responses have been updated for functional needs.
- Access token and refresh token are longer strings
- increased from 40 characters to ~1000 characters
- Some validation error descriptions have slightly been changed in wording
- description only, not logical error text
- Stricter validation rules regarding null values
- REST API v1 sometimes allowed null value e.g. in a Boolean unintentionally
- Nulls are by default forbidden
- Null values are allowed only if it makes sense in the context to unset certain attributes
- OAuth authentication is now case sensitive
- Client secret was earlier unintentionally used without case sensitivity
- This can only cause issues if the client secret is transformed into lowercase or uppercase format before usage
- Call recording links now contain the full file name
- In the old REST API version, the response of a "GET /calls/{id}" request would contain the record_file field without the file extension suffix
- In the new version the suffix is present in the file name
- Numeric ID values that previously returned strings have now been changed to proper integer type as they were intended
- Examples of such values:
/users -> id
/inbound_queues -> campaign_id
- Examples of such values:
New API calls
- Fetch an audio recording using the file name.
- Fetch an audio recording using the call ID.
- Create callbacks based on a contact ID.
- List a customer satisfaction score for a call or a message (session).
- GDPR calls on a contact ID level.
- Evacuate all calls or messages from a queue.
- (Omni only) Create a system message for a contact, to notify an agent of an event.
- New and more extensive calls to create, update or copy users.
Still have some questions?
Our technical support is happy to help you if you have any questions about updating to the new REST API version.
Email: support@leaddesk.com
Phone: Find the country specific Support numbers here