Leads

Create or update a lead by external channel identity

Upserts on channel plus externalUserId. Send the same identity twice and you update that lead instead of creating a second one. Emits lead.created, and lead.stage_changed too if the request moves the lead's stage.

API key scopes: leads:write. You also need an Idempotency-Key header.

post/api/leads

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/leads
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Request body

channel'telegram' | 'instagram' | 'messenger' | 'whatsapp' required
externalUserIdstring required
displayNamestring
stagestring
customFieldsobject
tagsstring[]

Response

ok

idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.