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

A unique key that identifies this lead. Can be either the lead's external_key or key value.

Body Params
int32 | null

Lead amount in cents

boolean | null

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

string | null

Unique identifier to be used for Customer after a lead has been converted

string

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

stage_data
object | null

Information about the current lead's stage

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:
Responses

Updated 7 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 7 months ago