Skip to main content
POST
/
v1
/
subscribers
Newsletter subscribers
curl --request POST \
  --url https://api.example.com/v1/subscribers
{
  "data": {
    "id": "[email protected]",
    "name": "John Doe",
    "email": "[email protected]",
    "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

ParameterTypeRequiredDescription
idstringNoUnique ID (auto-generated, or synced from ESP)
emailstringYesUnique email address
namestringNoSubscriber’s name
tosbooleanNoTerms of service accepted
marketing_consentbooleanNoMarketing consent given
statusstringNoactive, rejected, suspended
approvedbooleanNoWhether subscriber is approved
referralobjectNoThe subscriber who referred this person
referral.idstringYes*Referring subscriber’s ID
referral.emailstringYes*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": "[email protected]",
    "name": "John Doe",
    "tos": true,
    "marketing_consent": true,
    "status": "active",
    "approved": true
  }'

​
Response

{
  "data": {
    "id": "[email protected]",
    "name": "John Doe",
    "email": "[email protected]",
    "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

FieldTypeDescription
portal_linkstringLink to subscriber’s portal
share_linkstringSubscriber’s referral link to share
referrals_countintegerNumber of referred subscribers
is_referredbooleanWhether this subscriber was referred
rewardarrayEarned rewards

​
List Subscribers

GET https://api.partnero.com/v1/subscribers
ParameterTypeDescription
limitintegerResults per page (10-250, default: 10)
pageintegerPage number
refer_statusstringFilter: referred or non_referred

​
Get Subscriber

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

​
Search Subscribers

GET https://api.partnero.com/v1/subscribers:[email protected]

​
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}