Update lead status

PUT

/api/nova/leads/{leadId}/status

Changes the status of a lead to the given status from the account's master data. The request body requires statusId and accepts optional comments recorded with the change. Returns 400 when statusId is missing and 404 when either the lead or the status cannot be found. On success the lead id is returned. Responds with 401 for an invalid API key and 429 when API usage limits are exceeded.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

leadId*

leadId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"comments": "string",

  

"reasonId": "string",

  

"statusId": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/leads/{leadId}/status

Playground

Authorization

privateApiKey

Variables

Key

Value

leadId*

apiKey*

Body

Samples