Update a lead

ProRead & write key

Available on the Pro and Enterprise plans (beta).

PATCH…/public/leads/{id}

Changes only the fields you send and sends the lead.updated event to your webhooks. The response is the updated record.

Request
curl https://app.reshta.ir/api/v1/public/leads/0192c4e8-7b1a-7c3e-9f20-5d6a1b2c3d4e \​  -X PATCH \​  -H "Authorization: Bearer $RESHTA_API_KEY" \​  -H "Idempotency-Key: 7f3c2b1e-4a5d-4c6f-9e1a-2b3c4d5e6f70" \​  -H "Content-Type: application/json" \​  -d '{}'​

Headers

AuthorizationstringrequiredBearer followed by the business API key (rk_live_…).
Idempotency-KeystringrequiredA unique ID for this operation, such as a fresh UUID; retrying with the same key does nothing twice.
Content-Typeapplication/jsonrequiredThe body is UTF-8 JSON.

Path parameters

iduuidrequiredThe record ID (UUID).

Body parameters

namestring | nulloptionalCompany name.
emailemail | nulloptional
phonestring | nulloptional
company_namestring | nulloptional
sourcestring | nulloptionalThrough the API only manual or api; the others are set by the integrations.
utmobject | nulloptional
statusstringoptionalvalues:newworkingqualifieddiscarded
owner_iduuid | nulloptionalOnly records owned by this teammate.
customobjectoptionalCustom fields, keyed by field key.

Responses and errors

200—Done; the body is the record.
400validation_errorInvalid body, or no Idempotency-Key; details names the field.
401unauthorizedThe key is missing, wrong or revoked, or its creator is no longer active.
403forbiddenThe key has no write access.
404not_foundNo such record in this business.
409conflictThis Idempotency-Key came with another body, or is still in progress.
429rate_limitedOver 120 requests per minute; Retry-After says how many seconds to wait.
Response
400
{​  "error": {​    "code": "validation_error",​    "message": "Idempotency-Key header is required",​    "details": [​      {​        "field": "idempotency_key",​        "message": "idempotency_key_required"​      }​    ]​  }​}​
Related webhook: lead.updated

Create an API key and send your first request

Keys are created in the Reshta app and shown once. The API and webhooks (beta) are on the Pro and Enterprise plans, and only a business admin can create a key.

  1. 1Sign in at app.reshta.ir
  2. 2Connection → Developer
  3. 3Create API key