Create a lead

POSThttps://server.heyrik.com/api/v1/leads

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 6

Fields documented for this operation. See the request example for placement and structure.

namestringRequired

Contact name.

phonestring

E.164 — required if you want to call them.

emailstring

Contact email.

companystring

Company name.

stagestring

Pipeline stage. Defaults to the first stage.

customobject

Any extra fields — become {{variables}} on a call.

Response

No response example is documented for this operation yet.

Error reference

POST/leads

cURL

curl -X POST https://server.heyrik.com/api/v1/leads \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ravi Kumar",
    "phone": "+919876543210",
    "company": "Acme",
    "stage": "new",
    "custom": { "order_id": "AC-8842" }
  }'

Illustrative examples · No live request is sent