Subscribe & unsubscribe contacts

If you have questions regarding this API, please visit our API FAQ page.

These two endpoints bulk-change the subscription status of existing contacts within a single contacts list. They are symmetric: subscribe sets the contacts’ status to subscribed, unsubscribe sets it to unsubscribed.

Subscribing contacts

Make a POST request to https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/contacts/subscribe/ with a valid X-API-Key. Pass one or more contact ids in the body.

curl -X POST 'https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/contacts/subscribe/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contacts_ids": [4821, 4822]
  }'

Unsubscribing contacts

Make a POST request to https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/contacts/unsubscribe/ with the same body shape.

curl -X POST 'https://webapi.inboxroad.com/api/v2/contacts-lists/{blueprint_id}/contacts/unsubscribe/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contacts_ids": [4821, 4822]
  }'

Path parameters

Param name	Description
blueprint_id	Unique identifier of the contacts list (UUID).

Request fields

Field name	Required	Description
contacts_ids	Yes	Array of contact ids (integers) whose status to change. All must belong to the given list.

Response

Returns 200 with a human-readable confirmation message.

{
  "message": "Subscribed 2 contacts"
}

The unsubscribe endpoint returns the same shape, e.g. "Unsubscribed 2 contacts".

Possible response codes

Status code	Description
200	Subscription status updated successfully.
401	Unauthorized.
403	Action not available for your account. Body: { "errors": [ ... ] }.