Update a lead

PATCHhttps://server.heyrik.com/api/v1/leads/{id}

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 3

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

name / phone / email / companystring

Any of the core fields.

stagestring

Moving stage here is recorded on the lead's timeline too.

customobject

Extra fields — become {{variables}} on a call.

Response

No response example is documented for this operation yet.

Error reference

PATCH/leads/{id}

cURL

curl -X PATCH https://server.heyrik.com/api/v1/leads/lead_71a4 \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "company": "Acme Ltd", "custom": { "plan": "pro" } }'

Illustrative examples · No live request is sent