Send a lead

Receives a lead and places it in the initial stage of the funnel. Either a phone number or an email is required. The lead is processed right after it is accepted. If a lead with the same email and phone already exists, it is updated. Limit of 120 requests per minute.

POST /api/webhooks/leads

cURL

formulario

curl --request POST \
  --url https://seu-dominio/api/webhooks/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Maria Souza",
  "phone": "[phone]",
  "email": "[e-mail]",
  "source": "site",
  "notes": "Asked for contact about the annual plan"
}
'

202

{
  "message": "Lead accepted for processing"
}

Authorizations

Authorization · string · header · required

Token generated in Settings, Integrations, Lead Webhook tab, Generate New Security Token button. Send it as Authorization: Bearer YOUR_TOKEN.

Body

application/json

Provide at least phone or email.

name · string

Lead name. Without a name, the lead is created as Novo Lead.

Maximum string length: 255

phone · string

Phone number. Only the digits are kept.

Maximum string length: 50

email · string<email>

Lead email.

Maximum string length: 255

source · string

Lead source, for example site or rd_station.

Maximum string length: 100

notes · string

Notes about the lead.

Response

202

application/json

Lead accepted for processing.

message · string

Example:

"Lead accepted for processing"