Newsletter subscribers

Manage subscribers in Newsletter Referral programs

POST /v1/subscribers

Newsletter subscribers

cURL

curl --request POST \
  --url https://api.example.com/v1/subscribers

201 Created

{
  "data": {
    "id": "[e-mail]",
    "name": "John Doe",
    "email": "[e-mail]",
    "is_referred": false,
    "tos": true,
    "marketing_consent": true,
    "status": "Active",
    "approved": true,
    "portal_link": "https://partnero.referral.site/portal/xxx",
    "share_link": "https://partnero.referral.site/share/xxx",
    "referrals_count": 0,
    "reward": [],
    "created_at": "2025-05-12T22:03:20.000000Z"
  },
  "status": 1
}

Create Subscriber

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

Subscribers are automatically created when signing up via the Partnero portal or through ESP sync.

Request Body

Parameter	Type	Required	Description
id	string	No	Unique ID (auto-generated, or synced from ESP)
email	string	Yes	Unique email address
name	string	No	Subscriber’s name
tos	boolean	No	Terms of service accepted
marketing_consent	boolean	No	Marketing consent given
status	string	No	active, rejected, suspended
approved	boolean	No	Whether subscriber is approved
referral	object	No	The subscriber who referred this person
referral.id	string	Yes*	Referring subscriber’s ID
referral.email	string	Yes*	Referring subscriber’s email

Request

cURL

curl --location 'https://api.partnero.com/v1/subscribers' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "name": "John Doe",
    "tos": true,
    "marketing_consent": true,
    "status": "active",
    "approved": true
  }'

Response

201 Created

{
  "data": {
    "id": "[e-mail]",
    "name": "John Doe",
    "email": "[e-mail]",
    "is_referred": false,
    "tos": true,
    "marketing_consent": true,
    "status": "Active",
    "approved": true,
    "portal_link": "https://partnero.referral.site/portal/xxx",
    "share_link": "https://partnero.referral.site/share/xxx",
    "referrals_count": 0,
    "reward": [],
    "created_at": "2025-05-12T22:03:20.000000Z"
  },
  "status": 1
}

Response Fields

Field	Type	Description
portal_link	string	Link to subscriber’s portal
share_link	string	Subscriber’s referral link to share
referrals_count	integer	Number of referred subscribers
is_referred	boolean	Whether this subscriber was referred
reward	array	Earned rewards

List Subscribers

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

Parameter	Type	Description
limit	integer	Results per page (10-250, default: 10)
page	integer	Page number
refer_status	string	Filter: referred or non_referred

Get Subscriber

GET https://api.partnero.com/v1/subscribers/{id|email}

Search Subscribers

GET https://api.partnero.com/v1/subscribers:search?email=[e-mail]

Update Subscriber

PUT https://api.partnero.com/v1/subscribers/{id|email}

{
  "update": {
    "name": "Updated Name",
    "status": "active",
    "approved": true
  }
}

Delete Subscriber

DELETE https://api.partnero.com/v1/subscribers/{id|email}