Partnero Developers

Leads

A lead is someone who has expressed interest in your product or service by submitting a form or interacting with your platform, but has not yet signed up as a customer. Leads are typically collected through referral forms shared by your affiliate program partners and can later be converted into customers.

Lead details

Get basic details about a lead setup.

At this endpoint you can get the basic information about a lead setup. This endpoint is used to get the lead status, commission settings for leads and eventually custom fields form.

GET https://api.partnero.com/v1/leads/details

Response

{
  "data": {
    "leads_enabled": "true",
    "program_leads_commission_type": "follow_program_settings",
    "leads_commission": {
      "currency": "USD",
      "commission": 19,
      "commission_type": "percent"
    },
    "leads_custom_form_fields": [
      {
        "id": 88,
        "type": "text",
        "title": "",
        "text": "<p>Text custom field</p>",
        "description": null,
        "required": false,
        "options": []
      },
      {
        "id": 89,
        "type": "input",
        "title": "Input custom field",
        "text": "",
        "description": null,
        "required": true,
        "options": []
      },
      {
        "id": 90,
        "type": "textarea",
        "title": "TextArea custom input",
        "text": "",
        "description": null,
        "required": false,
        "options": []
      },
      {
        "id": 91,
        "type": "checkbox",
        "title": "Custom field chbx",
        "text": "",
        "description": null,
        "required": false,
        "options": [
          "chbx1",
          "chbx2",
          "chbx3"
        ]
      },
      {
        "id": 92,
        "type": "radio",
        "title": "Radio",
        "text": "",
        "description": null,
        "required": false,
        "options": [
          "radio1",
          "radio2"
        ]
      },
      {
        "id": 93,
        "type": "select",
        "title": "Select input",
        "text": "",
        "description": null,
        "required": false,
        "options": [
          "select1",
          "select2",
          "select3"
        ]
      },
      {
        "id": 94,
        "type": "countries",
        "title": "Custom field country select",
        "text": "",
        "description": null,
        "required": false,
        "options": []
      }
    ]
  },
  "status": 1
}

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

Create a lead

Create a new lead with required data.

The data payload should contain name and email data directly and a partner data object. partner data object is important to identify the partner. If there is a custom fields form, it should be sent as a separate data object under cfields key and the mappings should be ids of the custom fields like in the example below.

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

Request example

{
  "name": "Alice Brown",
  "email": "alice.brown@partnero.com",
  "partner": {
    "key": "ref_123"
  },
  "cfields": {
    "89": "Explicabo Porro dol 11",
    "90": "Ratione praesentium 11",
    "91": [
      "chbx1",
      "chbx3"
    ],
    "92": "radio2",
    "93": "select1",
    "94": "HR"
  }
}

Request parameters

ParametersTypeRequiredDetails
namestringyesA name for the lead.
emailstringyesAn email address of the lead.
partnerobject[]yesPartner data.
partner.keystringyesMust provide the partner's key to whom you are willing to create a customer(lead). Should be populated with *UNIQUE_PARTNER_KEY.
partner.idstringoptionalAlternatively, Partner ID can be used instead of key.
partner.emailstringoptionalAlternatively, Partner email address can be used instead of key.
cfieldsobject[]optionalCustom leads form. If there are required form fields this parameter is required.

*You have to populate partner.key data object with UNIQUE_PARTNER_KEY, which is saved in partnero_partner cookie created by our universal javascript snippet or can be identified from the URL.

**The URL must be a unique referral URL which was assigned to a partner.

Response

{
  "data": {
    "id": 44,
    "status": "submitted",
    "created_at": "2025-05-16",
    "lead_info": {
      "name": "Alice Brown",
      "email": "alice.brown@partnero.com"
    },
    "converted_to": null,
    "submitter": {
      "id": "woenfyig1ugu",
      "name": "Damjan Krivacevic",
      "email": "damjan@partnero.com"
    },
    "submission_form": [
      {
        "question": "Name",
        "answer": "Alice Brown"
      },
      {
        "question": "Email address",
        "answer": "alice.brown@partnero.com"
      },
      {
        "question": "",
        "answer": null
      },
      {
        "question": "Input custom field",
        "answer": "Explicabo Porro dol 11"
      },
      {
        "question": "TextArea custom input",
        "answer": "Ratione praesentium 11"
      },
      {
        "question": "Custom field chbx",
        "answer": "chbx1, chbx3"
      },
      {
        "question": "Radio",
        "answer": "radio2"
      },
      {
        "question": "Select input",
        "answer": "select1"
      },
      {
        "question": "Custom field country select",
        "answer": "Croatia"
      }
    ],
    "can_be_converted": true,
    "can_be_rejected": true
  },
  "status": 1
}

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

Fetch a lead

Get the details about a specific lead. You need to provide an id.

GET https://api.partnero.com/v1/leads/{id}

Request example

GET https://api.partnero.com/v1/leads/44

Request parameters

ParametersTypeRequiredDetails
idintyes

Response

{
  "data": {
    "id": 44,
    "status": "submitted",
    "created_at": "2025-05-16",
    "lead_info": {
      "name": "Alice Brown",
      "email": "alice.brown@partnero.com"
    },
    "converted_to": null,
    "submitter": {
      "id": "woenfyig1ugu",
      "name": "Damjan Krivacevic",
      "email": "damjan@partnero.com"
    },
    "submission_form": [
      {
        "question": "Name",
        "answer": "Alice Brown"
      },
      {
        "question": "Email address",
        "answer": "alice.brown@partnero.com"
      },
      {
        "question": "",
        "answer": null
      },
      {
        "question": "Input custom field",
        "answer": "Explicabo Porro dol 11"
      },
      {
        "question": "TextArea custom input",
        "answer": "Ratione praesentium 11"
      },
      {
        "question": "Custom field chbx",
        "answer": "chbx1, chbx3"
      },
      {
        "question": "Radio",
        "answer": "radio2"
      },
      {
        "question": "Select input",
        "answer": "select1"
      },
      {
        "question": "Custom field country select",
        "answer": "Croatia"
      }
    ],
    "can_be_converted": true,
    "can_be_rejected": true
  },
  "status": 1
}

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

Get all leads

Get the list of leads.

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

Request parameters

ParametersTypeRequiredDetails
limitintegernoA limit on the number of items to be returned. Limits can range between 1 and 250, and the default is 15.
pageintegernoThe default is 1.

Response

{
  "data": [
    {
      "id": 44,
      "status": "submitted",
      "created_at": "2025-05-16",
      "lead_info": {
        "name": "Alice Brown",
        "email": "alice.brown@partnero.com"
      },
      "converted_to": null,
      "submitter": {
        "id": "woenfyig1ugu",
        "name": "Damjan Krivacevic",
        "email": "damjan@partnero.com"
      },
      "submission_form": [
        {
          "question": "Name",
          "answer": "Alice Brown"
        },
        {
          "question": "Email address",
          "answer": "alice.brown@partnero.com"
        },
        {
          "question": "",
          "answer": null
        },
        {
          "question": "Input custom field",
          "answer": "Explicabo Porro dol 11"
        },
        {
          "question": "TextArea custom input",
          "answer": "Ratione praesentium 11"
        },
        {
          "question": "Custom field chbx",
          "answer": "chbx1, chbx3"
        },
        {
          "question": "Radio",
          "answer": "radio2"
        },
        {
          "question": "Select input",
          "answer": "select1"
        },
        {
          "question": "Custom field country select",
          "answer": "Croatia"
        }
      ],
      "can_be_converted": true,
      "can_be_rejected": true
    },
    {
      "id": 43,
      "status": "submitted",
      "created_at": "2025-05-16",
      "lead_info": {
        "name": "Dzumhur Zuko 11",
        "email": "dzumhur11@zuko11.com"
      },
      "converted_to": null,
      "submitter": {
        "id": "woenfyig1ugu",
        "name": "Damjan Krivacevic",
        "email": "damjan@partnero.com"
      },
      "submission_form": [
        {
          "question": "Name",
          "answer": "Dzumhur Zuko 11"
        },
        {
          "question": "Email address",
          "answer": "dzumhur11@zuko11.com"
        },
        {
          "question": "",
          "answer": null
        },
        {
          "question": "Input custom field",
          "answer": "Explicabo Porro dol 11"
        },
        {
          "question": "TextArea custom input",
          "answer": "Ratione praesentium 11"
        },
        {
          "question": "Custom field chbx",
          "answer": "chbx1, chbx3"
        },
        {
          "question": "Radio",
          "answer": "radio2"
        },
        {
          "question": "Select input",
          "answer": "select1"
        },
        {
          "question": "Custom field country select",
          "answer": "Croatia"
        }
      ],
      "can_be_converted": true,
      "can_be_rejected": true
    },
    ...
  ],
  "links": {
    "first": "http://api.partnero.com/v1/leads?page=1",
    "last": null,
    "prev": null,
    "next": "http://api.partnero.com/v1/leads?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "http://api.partnero.com/v1/leads",
    "per_page": 10,
    "to": 10
  },
  "status": 1
}

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

Convert a lead

GET https://api.partnero.com/v1/leads/convert

Request example

GET https://api.partnero.com/v1/leads/convert

Available search query parameters

ParametersTypeRequiredDetails
idstringyes
commission_transaction_amountstringyes

Response

{
  "data": {
    "id": 44,
    "status": "converted",
    "created_at": "2025-05-16",
    "lead_info": {
      "name": "Alice Brown",
      "email": "alice.brown@partnero.com"
    },
    "converted_to": {
      "key": "NSpBI1qWSE4J",
      "name": "Alice Brown",
      "email": "alice.brown@partnero.com"
    },
    "submitter": {
      "id": "woenfyig1ugu",
      "name": "Damjan Krivacevic",
      "email": "damjan@partnero.com"
    },
    "submission_form": [
      {
        "question": "Name",
        "answer": "Alice Brown"
      },
      {
        "question": "Email address",
        "answer": "alice.brown@partnero.com"
      },
      {
        "question": "",
        "answer": null
      },
      {
        "question": "Input custom field",
        "answer": "Explicabo Porro dol 11"
      },
      {
        "question": "TextArea custom input",
        "answer": "Ratione praesentium 11"
      },
      {
        "question": "Custom field chbx",
        "answer": "chbx1, chbx3"
      },
      {
        "question": "Radio",
        "answer": "radio2"
      },
      {
        "question": "Select input",
        "answer": "select1"
      },
      {
        "question": "Custom field country select",
        "answer": "Croatia"
      }
    ],
    "can_be_converted": false,
    "can_be_rejected": false
  },
  "status": 1
}

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

Reject a lead

GET https://api.partnero.com/v1/leads/reject

Request example

GET https://api.partnero.com/v1/leads/reject

Request parameters

ParametersTypeRequiredDetails
idintyes

Response

{
  "data": {
    "id": 43,
    "status": "rejected",
    "created_at": "2025-05-16",
    "lead_info": {
      "name": "Dzumhur Zuko 11",
      "email": "dzumhur11@zuko11.com"
    },
    "converted_to": null,
    "submitter": {
      "id": "woenfyig1ugu",
      "name": "Damjan Krivacevic",
      "email": "damjan@partnero.com"
    },
    "submission_form": [
      {
        "question": "Name",
        "answer": "Dzumhur Zuko 11"
      },
      {
        "question": "Email address",
        "answer": "dzumhur11@zuko11.com"
      },
      {
        "question": "",
        "answer": null
      },
      {
        "question": "Input custom field",
        "answer": "Explicabo Porro dol 11"
      },
      {
        "question": "TextArea custom input",
        "answer": "Ratione praesentium 11"
      },
      {
        "question": "Custom field chbx",
        "answer": "chbx1, chbx3"
      },
      {
        "question": "Radio",
        "answer": "radio2"
      },
      {
        "question": "Select input",
        "answer": "select1"
      },
      {
        "question": "Custom field country select",
        "answer": "Croatia"
      }
    ],
    "can_be_converted": true,
    "can_be_rejected": false
  },
  "status": 1
}

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

Delete a lead submission

Delete an existing lead submission.

DELETE https://api.partnero.com/v1/leads/{id}

Request example

DELETE https://api.partnero.com/v1/leads/44

Request parameters

ParametersTypeRequiredDetails
idstringyes

Response

{
  "status": 1
}

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