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.

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

{
  "email": "ross.geller@partnero.com",
  "name": "Ross Geller",
  "tos": true,
  "marketing_consent": true,
  "status": "active",
  "approved": true
}

Request parameters

Parameters	Type	Required	Details
`id`	`string`	optional	If your 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	The name of the subscriber.
`tos`	`bool`	optional	If terms of service are accepted. Possible values: `true`, `false`.
`marketing_consent`	`bool`	optional	If marketing consent is accepted. Possible values: `true`, `false`.
`status`	`string`	optional	Possible values: `active`, `rejected`, `suspended`.
`approved`	`bool`	optional	If the subscriber is approved. Possible values: `true`, `false`.
`referral`	`object[]`	optional	When assigning who referred a subscriber.
`referral.email`	`string`	yes*	The email of the subscriber who referred the new subscriber. You must provide either `email` or `id`.
`referral.id`	`string`	yes*	The id of the subscriber who referred the new subscriber. You must provide either `email` or `id`.

Response

{
    "data": {
        "id": null,
        "name": "Ross Geller",
        "email": "ross.geller@partnero.com",
        "is_referred": false,
        "tos": true,
        "marketing_consent": true,
        "status": "Active",
        "approved": true,
        "portal_link": "https://partnero.referral.site/portal/JwSK/gwLwK/8f8crG6gcoaRHgQO",
        "share_link": "https://partnero.referral.site/share/gwLwK/JvdC1",
        "referrals_count": 0,
        "reward": [],
        "created_at": "2025-05-12T22:03:20.000000Z",
        "updated_at": "2025-05-12T22:03:20.000000Z",
        "deleted_at": null
    },
    "status": 1
}

Response Code: 201 Created
Content-Type: application/json

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 example

GET https://api.partnero.com/v1/subscribers/ross.geller@partnero.com

Request parameters

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

Response

{
    "data": {
        "id": "ross.geller@partnero.com",
        "name": "Ross Geller",
        "email": "ross.geller@partnero.com",
        "is_referred": false,
        "tos": true,
        "marketing_consent": true,
        "status": "Active",
        "approved": true,
        "portal_link": "https://partnero.referral.site/portal/JwSK/gwLwK/8f8crG6gcoaRHgQO",
        "share_link": "https://partnero.referral.site/share/gwLwK/JvdC1",
        "referrals_count": 0,
        "reward": [],
        "created_at": "2025-05-12T22:03:20.000000Z",
        "updated_at": "2025-05-12T22:03:22.000000Z",
        "deleted_at": null
    },
    "status": 1
}

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

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	Filter by referral status. Possible values: `referred`, `non_referred`.

Response

Valid

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

{
    "data": [
        {
            "id": "ross.geller@partnero.com",
            "name": "Ross Geller",
            "email": "ross.geller@partnero.com",
            "is_referred": false,
            "tos": true,
            "marketing_consent": true,
            "status": "Active",
            "approved": true,
            "portal_link": "https://partnero.referral.site/portal/JwSK/gwLwK/8f8crG6gcoaRHgQO",
            "share_link": "https://partnero.referral.site/share/gwLwK/JvdC1",
            "referrals_count": 0,
            "reward": [],
            "created_at": "2025-05-12T22:03:20.000000Z",
            "updated_at": "2025-05-12T22:03:22.000000Z",
            "deleted_at": null
        },
        ...
    ],
    "links": {
        "first": "https://api.partnero.com/v1/subscribers?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.partnero.com/v1/subscribers",
        "per_page": 10,
        "to": 2
    },
    "status": 1
}

Invalid

Response Code: 404 Not Found

Find a subscriber

Search for a subscriber.

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

Request example

GET https://api.partnero.com/v1/subscribers:search?email=ross.geller@partnero.com

Available search query parameters

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

Response

{
    "data": [
        {
            "id": "ross.geller@partnero.com",
            "name": "Ross Geller",
            "email": "ross.geller@partnero.com",
            "is_referred": false,
            "tos": true,
            "marketing_consent": true,
            "status": "Active",
            "approved": true,
            "portal_link": "https://partnero.referral.site/portal/JwSK/gwLwK/8f8crG6gcoaRHgQO",
            "share_link": "https://partnero.referral.site/share/gwLwK/JvdC1",
            "referrals_count": 0,
            "reward": [],
            "created_at": "2025-05-12T22:03:20.000000Z",
            "updated_at": "2025-05-12T22:03:22.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://api.partnero.com/v1/subscribers:search?page=1",
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://api.partnero.com/v1/subscribers:search",
        "per_page": 10,
        "to": 1
    },
    "status": 1
}

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

Update a subscriber

Update an existing subscriber.

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

Request example

PUT https://api.partnero.com/v1/subscribers/ross.geller@partnero.com

{
  "update": {
    "name": "Monica Geller",
    "email": "monica.geller@partnero.com",
    "id": "monica.geller@partnero.com",
    "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

Response

{
    "data": {
        "id": "monica.geller@partnero.com",
        "name": "Monica Geller",
        "email": "monica.geller@partnero.com",
        "is_referred": false,
        "tos": true,
        "marketing_consent": true,
        "status": "Rejected",
        "approved": true,
        "portal_link": "https://partnero.referral.site/portal/JwSK/gwLwK/8f8crG6gcoaRHgQO",
        "share_link": "https://partnero.referral.site/share/gwLwK/JvdC1",
        "referrals_count": 0,
        "reward": [],
        "created_at": "2025-05-12T22:03:20.000000Z",
        "updated_at": "2025-05-12T22:10:54.000000Z",
        "deleted_at": null
    },
    "status": 1
}

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

Delete a subscriber

Delete an existing subscriber.

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

Request example

DELETE https://api.partnero.com/v1/subscribers/ross.geller@partnero.com

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
Content-Type: application/json

# Subscribers

# Create a subscriber

# Request example

# Request parameters

# Response

# Fetch a subscriber

# Request example

# Request parameters

# Response

# Get all subscribers

# Request parameters

# Response

# Valid

# Invalid

# Find a subscriber

# Request example

# Available search query parameters

# Response

# Update a subscriber

# Request example

# Request parameters

# Response

# Delete a subscriber

# Request example

# Request parameters

# Response

Subscribers

Create a subscriber

Request example

Request parameters

Response

Fetch a subscriber

Request example

Request parameters

Response

Get all subscribers

Request parameters

Response

Valid

Invalid

Find a subscriber

Request example

Available search query parameters

Response

Update a subscriber

Request example

Request parameters

Response

Delete a subscriber

Request example

Request parameters

Response