Skip to main content
PATCH
Change lead status

Authorizations

api_access_token
string
header
required

API access token for authentication. Obtain from your Voxys Connect profile settings.

Path Parameters

account_id
integer
required

The numeric ID of the account.

id
integer
required

The ID of the lead.

Body

application/json
status
enum<string>
required
Available options:
open,
won,
lost,
snoozed
Example:

"won"

notes
string | null
Example:

"Closed deal after final negotiation."

Response

Status updated.

id
integer
Example:

42

custom_name
string
Example:

"Enterprise Deal - Q3"

status
enum<string>
Available options:
open,
won,
lost,
snoozed
Example:

"open"

lead_value
number<float> | null
Example:

15000

lead_currency
string | null
Example:

"USD"

position
integer | null
Example:

1

notes
string | null
Example:

"Prospect from trade show"

assigned_agent
object | null
company
object | null
conversation_id
integer | null
Example:

100

custom_attributes
object

Flexible key-value map of custom attributes defined for the account.

Example:
created_at
string<date-time>
updated_at
string<date-time>