API reference

Leads

1 operations. Base URL: https://api.ringura.com/api/v1. Authenticate with a bearer token that carries the scope named on each operation.

POST `/api/v1/leads`

A new lead for a speed-to-lead source: top of its campaign's hopper and its sequence's first step due now; dialled or messaged at once when the gate allows.

Scope: leads:write
Operation id: createLead
Idempotent: Send Idempotency-Key to make a retry safe

Parameters

Parameters of POST /api/v1/leads
Name	In	Type	Required	Constraints
`Idempotency-Key`	header	string	No	matches ^[A-Za-z0-9_.:-]{8,100}$

Request body

JSON (Content-Type: application/json).

Request body of POST /api/v1/leads
Field	Type	Required	Constraints
`sourceId`	string (uuid)	Yes
`phone`	string	Yes	4-32 characters
`defaultCountry`	string	No	matches ^[A-Z]{2}$
`name`	string	No	at most 200 characters
`email`	string	No	at most 320 characters
`externalId`	string	No	1-200 characters
`consent`	boolean	No
`timeZone`	string	No	at most 64 characters
`fields`	object	No	free-form object

Response

201 JSON with these fields.

Response fields of POST /api/v1/leads
Field	Type	Required
`event`	object	Yes
`event.id`	string (uuid)	Yes
`event.sourceId`	string (uuid)	Yes
`event.leadId`	string (uuid)	Yes
`event.via`	string	Yes
`event.externalId`	string or null	Yes
`event.receivedAt`	string (date-time)	Yes
`event.targetSeconds`	integer	Yes
`event.firstAction`	string or null	Yes
`event.firstActionAt`	string (date-time) or null	Yes
`event.seconds`	number or null	Yes
`event.met`	boolean or null	Yes
`duplicate`	boolean	Yes

Errors

400, 401, 403, 404, 409, 422, 429. What each status means

Example request

curl -X POST 'https://api.ringura.com/api/v1/leads' \
  -H "Authorization: Bearer $CC_TOKEN" \
  -H 'Idempotency-Key: order-2027-0001' \
  -H 'Content-Type: application/json' \
  -d '{
  "sourceId": "0192f5a0-7c1e-7d3a-9b2e-3f4a5b6c7d8e",
  "phone": "+441632960000"
}'