Partners

Partner is a person/company who shares a unique affiliate link with their audience so they can get rewarded once people sign up on a paid plan through their link.

Get all partners

Get the list of Partners that belong to your program.

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

Request parameters

Parameters	Type	Required	Details
limit	integer	no	A limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 15.
page	integer	no	The default is 1.

Response

Valid

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

{
    "data": [
        {
            "email": "partner@partnero.com",
            "created_at": "2022-09-28T11:51:50.000000Z",
            "updated_at": "2022-09-28T11:51:50.000000Z",
            "key": "lphs8bcrfmgv",
            "name": "Partnero",
            "surname": "Partner",
            "approved": true,
            "status": "active"
        }
      ...
    ]
}

Invalid

Response Code: 404 Not Found

Create a partner

Create a new partner. Please note that partners are being created automatically when someone signs up within Partnero Partner portal.

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

Request example

{
  "id": "PARTNER_ID",
  "email": "partner@partnero.com",
  "name": "Partnero",
  "password": "W6qtZMGyCD6Gj2ZrtrVa"
}

Request parameters

Parameters	Type	Required	Details
id	string	optional	ID of the partner. Not required, but must be unique if provided. If not provided, id is generated automatically.
email	string	yes	Must be a unique email address.
name	string	optional
password	string	yes	The password must be at least 8 characters and contain at least 1 lowercase, 1 uppercase, and 1 number.
key	string	optional	Key will be used to generate an unique referral link. If not provided, key is generated automatically.
referring_partner	object[]	optional
referring_partner.id	string	optional	Referring partner ID. When assigning a referring partner, you have the option to choose by their id, key or email.
referring_partner.key	string	optional	Referring partner key. When assigning a referring partner, you have the option to choose by their id, key or email.
referring_partner.email	string	optional	Referring partner email address. When assigning a referring partner, you have the option to choose by their id, key or email.

Fetch a partner

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

GET https://api.partnero.com/v1/partners/(:id)

Request parameters

Parameters	Type	Required	Details
id	string	yes *	ID of the partner.

Find a partner

Search for a partner.

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

Available search query parameters

Parameters	Type	Required	Details
id	string	optional	ID of the partner.
email	string	optional	Email address of the partner.
key	string	optional	Any referral key that belongs to the partner.

Invite a partner

Invite a partner via email notification

POST https://api.partnero.com/v1/partners:invite

Available parameters

Parameters	Type	Required	Details
email	string	required	Email address of the partner.
name	string	required	Name of the partner.

Update a partner

Update an existing partner.

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

Request example

{
  "update": {
    "email": "jane@partnero.com",
    "name": "Jane",
    "surname": "Partner",
    "password": "AkPfEp1R"
  }
}

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.surname	string	optional
update.password	string	optional	The password must be at least 8 characters and contain at least 1 lowercase, 1 uppercase, and 1 number.

Delete a partner

Delete an existing partner.

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

Archive a partner

Archive an existing partner.

POST https://api.partnero.com/v1/partners/(:id)/archive

Revoke archived partner

Revoke archived partner.

POST https://api.partnero.com/v1/partners/(:id)/revoke-archive