Subscribers

A newsletter referral program subscriber is an individual who joins a newsletter and shares a unique referral link with their network. When others sign up for the newsletter through the subscriber’s link, the subscriber earns rewards or benefits as part of the referral program.

Get all subscribers

Get the list of Subscribers that belong to your program.

GET https://api.partnero.com/v1/subscribers

Request parameters

Parameters	Type	Required	Details
limit	integer	no	A limit on the number of items to be returned. Limits can range between 10 and 250, and the default is 10.
page	integer	no	The default is 1.
refer_status	integer	no	['referred', 'non_referred']

Response

Valid

Response Code: 200 OK
Response Headers:
    Content-Type: application/json

{
    "data": [
        {
            "id": "113965815471015338",
            "name": "Partnero Partner",
            "email": "partnero@partner.com",
            "is_referred": false,
            "tos": null,
            "marketing_consent": null,
            "status": "Active",
            "approved": true,
            "portal_link": "https://domain.subscriberapp.test/portal/x7Xz/3rk3b/lmD3teVdPFQtDuP1",
            "share_link": "https://domain.subscriberapp.test/share/3rk3b/vh5PP",
            "referrals_count": 0,
            "reward": [],
            "created_at": "2024-09-02T09:03:18.000000Z",
            "updated_at": "2024-09-02T09:03:38.000000Z",
            "deleted_at": null
        }
      ...
    ]
}

Invalid

Response Code: 404 Not Found

Create a subscriber

Create a new subscriber. Please note that subscribers are being created automatically when someone signs up within Partnero Subscriber portal or via ESP if the subscribers synchronization is ON.

POST https://api.partnero.com/v1/subscribers

Request example

{
  "id": "esp_identifier",
  "email": "partner@partnero.com",
  "name": "Partnero Partner",
  "tos": true,
  "marketing_consent": true,
  "status": "active",
  "approved": true,
  "referral":{
      "email": "api+test+2@email.com"
  }
}

Request parameters

Parameters	Type	Required	Details
id	string	optional	If you're account is connected to some of the ESP, and the sync is on, you should not pass the id, as the identifier will be updated to an ESP identifier. This will be a subscriber id you use in the API.
email	string	yes	Must be a unique email address.
name	string	optional
tos	bool	optional
marketing_consent	bool	optional
status	string	optional	['active', 'rejected', 'suspended']
approved	bool	optional
referral	object[]	optional	When assigning who referred a subscriber, you have the option to identify them either by their id or email.

Fetch a subscriber

Get the details about specific subscriber. You need to provide either an email address or a unique id of the subscriber.

GET https://api.partnero.com/v1/subscribers/(:id|email)

Request parameters

Parameters	Type	Required	Details
id	string	yes *	Must provide either id or email.
email	string	yes *	Must provide either id or email.

Find a subscriber

Search for a subscriber.

GET https://api.partnero.com/v1/subscribers:search

Available search query parameters

Parameters	Type	Required	Details
id	string	optional	ID of the subscriber.
email	string	optional	Email address of the subscriber.

Update a subscriber

Update an existing subscriber.

PUT https://api.partnero.com/v1/subscribers/(:id)

Request example

{
  "update": {
    "name": "Jane Doe",
    "email": "jane@partnero.com",
    "id": "id_113965815471015338",
    "tos": true,
    "status": "rejected",
    "approved": true
  }
}

Request parameters

Parameters	Type	Required	Details
id	string	yes *	Must provide either id or email.
email	string	yes *	Must provide either id or email.
update	object[]	optional
update.email	string	optional	Must be a unique email address.
update.name	string	optional
update.id	string	optional
update.tos	bool	optional
update.status	string	optional	['active', 'rejected', 'suspended']
update.approved	bool	optional

Delete a subscriber

Delete an existing subscriber.

DELETE https://api.partnero.com/v1/subscribers/(:id)

Request parameters

Parameters	Type	Required	Details
id	string	yes *	Must provide either id or email.
email	string	yes *	Must provide either email or id.

Response

{
  "status": 1
}

Response Code: 200 OK