GuidesAPI Reference
API Reference
SupportPartnerStack Login

Create a lead

post
https://api.partnerstack.com/api/v2/leads

Creates a lead with desired params.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Leads are submitted by your partners to let your sales team know of potential accounts that they may wish to work. Partners may earn comission for qualified leads, or leads that eventually become closed accounts.

int32 | null

Lead amount in cents

boolean | null
enum

Used to indicate whether this lead has been approved to move past the closed stage

Allowed:
string
required

Reference that can be used in place of the key. Often given as leads email

field_data
object | null
fields
array of objects
fields
string | null
meta
object | null
required

Key value pairs that store additional information about this lead. First and last name required. Other eligable keys are based on Lead forms created. Use the /leads/form-template to view field names

string | null
string
required
length ≤ 255

The unique key of the partner who submitted this lead

string
enum
required

Current status of this lead. Must be one of either 'open', 'closed', 'dead', 'closed won', or 'closed lost'

Allowed:
Responses

Updated 9 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago