NEWAutomation apps: connect SendCoop to Zapier, Pabbly, Make and n8n.New: Zapier, Pabbly, Make, n8nSee how →
Start free

API keys and REST API basics

Create SendCoop API keys and make your first REST API request with a Bearer token to manage lists, subscribers and campaigns.

The SendCoop REST API lets your own apps, scripts and tools manage lists, subscribers and campaigns. You authenticate every request with an API key.

Before you start

  • API access must be included in your plan. If you don’t see the API tab under Integrations, it isn’t.

Create an API key

  1. In the left sidebar, click Integrations, then the API tab.
  2. Under API keys, enter a Key name, for example “Zapier” or “My website”.
  3. Click Create key.
  4. Copy the key straight away. For security it is shown only once.

Create a separate key for each app. That way you can delete one without breaking the others. You can have up to 25 named keys.

The Primary key at the top of the list is used by older integrations. Click Regenerate to replace it; apps using the old primary key stop working until you update them.

To revoke a named key, click Delete next to it. Apps using it stop working immediately.

Make your first request

The API endpoint is:

https://app.sendcoop.com/api/v1

Send your key in the Authorization header as a Bearer token:

curl -X GET 'https://app.sendcoop.com/api/v1/lists' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Quick reference

Method Endpoint What it does
GET /api/v1/lists Get all lists
POST /api/v1/lists Create a new list
GET /api/v1/subscribers Get subscribers
POST /api/v1/subscribers Add a subscriber
PATCH /api/v1/subscribers/{uid} Update a subscriber
GET /api/v1/campaigns Get all campaigns
POST /api/v1/campaigns Create a campaign

For every endpoint and its parameters, click Open API documentation on the API page.

Example: add a subscriber with tags

curl -X POST 'https://app.sendcoop.com/api/v1/subscribers' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d 'list_uid=YOUR_LIST_UID' \
  -d 'EMAIL=jane@example.com' \
  -d 'FIRST_NAME=Jane' \
  -d 'tag=vip,customer'

Field names match the tags on your list, such as EMAIL and FIRST_NAME. You can find a list’s UID with GET /api/v1/lists.

Tips

  • Keep keys secret. Never put them in website code that visitors can see.
  • To import many contacts at once, use the bulk import API. Open a list, go to Subscribers > Import and click Developer? Use the Bulk Import API.
  • For events going out of SendCoop (such as a new subscriber), use webhooks instead of polling the API.
Still need help? Email hello@sendcoop.com and we usually reply within one business day.