API overview and implementation
Marcel Ursprung avatar
Written by Marcel Ursprung
Updated over a week ago

What are APIs?

APIs (Application Programming Interface) make it possible to perform actions programatically and automatically without using the user interface. A common example is syncing contacts from a CRM system to Envoke.

Adding contacts from a CRM system to Envoke

Adding contacts from a CRM system to Envoke is the most common API use case. This way your Envoke account will always have an up to date list of contacts to send emails to. Because emails are sent from Envoke and subscriptions are managed automatically by Envoke there is no need to sync subscription details back to your CRM system.

Using a combination of read, insert, update and delete operations you can add and update contacts in Envoke as they change in your CRM system.

All contact fields can be updated via the API including custom fields, subscriptions, tags, and consent.

Additional APIs

You can also use the APIs to send transactional emails and for reporting.

It's also possible to update your CRM system when contact data changes in Envoke. This is done using web hooks.

Cost

Access to the APIs is available at no extra cost with the Professional, Multi-account and Pay As You Go Plans. API access is not available with the Standard plan. See billing plan details.

There is default daily API request limit of 1,000 requests/day. Contact our support team to increase this limit for your account. The daily limit should not exceed the number of contacts stored in your Envoke account.

Implementation

API integrations need to be implemented by your developers. After the initial setup integrations require only minimal ongoing maintenance. To help with this, Envoke provides:

  • detailed documentation that includes details about contact data fields and using the insert, read, update and delete operations to.

  • examples in 30 programming languages and a test environment at api.envoke.com

  • the option to book a technical support call dedicated to help with API implementation. This call is focused on API setup and should include the person (developer) who is implementing the APIs. This is a separate from the training call that covers the usage of the software.

Getting started with using the API

You can get your API connection credentials from the Integrations section of the Account Settings page.

The Envoke REST APIs use HTTP basic authentication. You need to send requests in JSON format. View documentation here. Examples and testing are available here.

Did this answer your question?