GuidesAPI Reference
API Reference
SupportPartnerStack Login

Update a lead

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

Updates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

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

Unique identifier of lead. Can be external_key, if one configured for lead.

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

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

string

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

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
length ≤ 255

The unique key of the partner who submitted this lead

string
enum

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

Allowed:
Responses

Updated about 1 year ago

Did this page help you?
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 about 1 year ago

Did this page help you?