Push leads in live

POSThttps://server.heyrik.com/api/v1/campaigns/{id}/contacts

Path parameters

idRequired

Replace {id} in the request URL with the value for this resource.

Headers

AuthorizationstringRequired

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

Get your API key

Parameters 1

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

contactsarrayRequired

[{ phone, name, …any custom fields }].

Response

No response example is documented for this operation yet.

Error reference

POST/campaigns/{id}/contacts

cURL

curl -X POST https://server.heyrik.com/api/v1/campaigns/cmp_4a19/contacts \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contacts": [
      { "phone": "+919876543210", "name": "Ravi", "order_id": "AC-8842" }
    ]
  }'

Illustrative examples · No live request is sent