GuidesAPI Reference
API Reference
SupportPartnerStack Login

Create a lead

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

Creates a lead with desired params.

Body Params
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

A unique key that identifies this lead in an external system. This key must be unique across all leads in your account. This key is used to identify leads when they are updated or deleted. Often provided as an email, but can be any unique string.

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

Key value pairs that store additional information about this lead. First and last name required. Other eligible 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 | null

The unique personal stack_key of the partner team member who submitted this lead. To select a team member, please pass either the personal_stack_key or the team_member_email.

string
required

The api_name of the Stage this lead should be in. This is used to determine the current stage of the lead. If not provided, the lead will be placed in the first stage of the sales cycle.

string
enum

Current status of this lead. Must be one of either 'open', 'closed', 'dead', 'closed won', or 'closed lost'. Note that open = New, closed = Qualified and dead = Unqualified default stages in the PartnerStack dashboard.

Allowed:
string | null

The email of the partner team member who submitted this lead. To select a team member, please pass either the personal_stack_key or the team_member_email.

Responses

Updated 7 months ago

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