Decline incoming leads

This method allows declining an incoming lead

Response parameters

ParameterData typeDescription
uidstringIncoming lead UID
categorystringIncoming lead category: sip, mail, chats, forms
pipeline_idintID of the pipeline in which the incoming lead is located
created_atintThe time and date the incoming lead was created in the format of Unix Timestamp
_embeddedobjectEmbedded entities data
_embedded[contacts]arrayData related to the contact of the incoming lead.
_embedded[0]objectContact model
_embedded[0][id]intContact ID
_embedded[companies]arrayData related to the company of the incoming lead.
_embedded[0]objectCompany model
_embedded[0][id]intCompany ID
_embedded[leads]arrayData related to the lead to which the incoming lead is connected .
_embedded[0]objectLead model
_embedded[0][id]intLead ID
Path Params
string
required

Lead UID

Body Params
int32

The ID of the user performing the decline

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json