Subscribers

Intro

Endpoint: https://sendmunk.com/api/v1/subscribers

Subscriber identifiers

Each subscriber can be identified by multiple identifiers (example: phone, email). Currently, we support identifiers of types 'email' and 'phone'.

Parameters

Parameter Type Description
sub_account_id integer User's subAccount ID in our system
contact_id integer Contacts identifier in our system.
email string Email Address
firstname string First Name
lastname string Last Name
phone string Phone number
form_id uuid Form ID in our system. This can be used to fetch subscribers who subscribed via a particular form
project_id integer Landing Page Project ID in our system. This can be used to fetch subscribers who subscribed via a landing page

List All Subscribers

GET /subscribers

Required parameters
  • api_secret  - Your API private key.
  • sub_account_id  - SubAccount ID.
Optional parameters
  • form_id  - Form ID to filter subscribers by subscription via a Form.
  • project_id  - Project ID to filter subscribers by subscription via a landing page.
Tip: If form_id and project_id are passed at the same time, subscribers will be filter based on subscription via both the form and landing page ID passed.

Get Subscriber's Info

GET /subscribers/{subscribers_id}

Required parameters
  • api_secret  - Your API private key.
  • sub_account_id  - SubAccount ID.

Subscriber's Tags

GET /subscribers/{subscribers_id}/tags

Required parameters
  • api_secret  - Your API private key.
  • sub_account_id  - SubAccount ID.

Subscriber's Activities

GET /subscribers/{subscribers_id}/activities

Required parameters
  • api_key  - Your API Public key.
  • sub_account_id  - SubAccount ID.
Optional parameters (Filters)
  • limit  - Limit and paginate the output
  • shoptrack  - To display Only Shop web activities. If shoptrack parameter is passed and set to 1, custom shop track activities for subscriber is returned and 0 to fetch all activities for the subscriber.

Create Subscriber

POST /subscribers

Required parameters
  • api_secret  - Your API private key.
  • sub_account_id  - SubAccount ID.
  • email  - Email address of subscriber.
Optional parameters
  • firstname  - First name of subscriber.
  • lastname  - Last name of subscriber.
  • phone  - Phone number of subscriber. (must be internationalized)

Update Subscriber

POST /subscribers/{subscriber_id}/update

Required parameters
  • api_secret  - Your API private key.
  • sub_account_id  - SubAccount ID.
  • email  - Email address of subscriber.
Optional parameters
  • firstname  - First name of subscriber.
  • lastname  - Last name of subscriber.
  • phone  - Phone number of subscriber. (must be internationalized)

Add Attribute to Subscriber

POST /subscribers/{subscriber_id}/attributes

Required parameters
  • api_secret  - Your API private key.
  • sub_account_id  - SubAccount ID.
  • attribute_ids  - Array of Atrribute IDs to attach to subscriber

Unsubscribe Subscriber

POST /unsubscribe

Required parameters
  • api_secret  - Your API private key.
  • email  - Email address of subscriber.