See Subscriber Management for the full guide.

​
Endpoints

MethodPathDescription
GET/api/v1/provider/subscribersList all subscribers
POST/api/v1/provider/subscribersCreate a subscriber
GET/api/v1/provider/subscribers/{id}Get a single subscriber
PATCH/api/v1/provider/subscribers/{id}Update subscriber details
All endpoints require X-API-Key authentication and are scoped to your provider.

​
Create subscriber body

{
  "email": "string (required)",
  "firstname": "string (required)",
  "lastname": "string (required)",
  "phonenumber": "string (optional)",
  "street": "string",
  "housenumber": "string",
  "postalcode": "string",
  "city": "string",
  "province": "string",
  "country": "Canada"
}

​
Update subscriber body

All fields optional. Only provided fields are updated. 
{
  "firstname": "string",
  "lastname": "string",
  "phonenumber": "string",
  "street": "string",
  "housenumber": "string",
  "postalcode": "string",
  "city": "string",
  "province": "string"
}