API URLs
Caution
This documentation covers version 2 of the Engage API. Voyado recommends, if possible, that you upgrade to version 3 to enjoy all the latest features. You can find the documentation for the Engage API version 3 at developer.voyado.com.
Voyado's APIs are accessed through a single base URL, made up of the client's name followed by voyado.com.
Caution
Use HTTPS for all interactions with the Voyado API
For the production environment the base URL form is:
https://[client].voyado.com
For the test environment (Staging) the base URL form will be:
https://[client].staging.voyado.com
Example
A client named ABC123 would have this base URL in the staging environment:
https://abc123.staging.voyado.com
And this URL in production:
https://abc123.voyado.com
In this documentation
In this documentation, the part of the URL that comes before /api will be left out and the HTTP method will be added before it. For example, instead of an instruction to make a GET request to:
https://abc123.staging.voyado.com/api/v2/contacts/{contactId}
You will just see this:
GET /api/v2/contacts/{contactId}
Refer back to this page if it's unclear what you need to put before /api to create a full URL.