Create or import a lead in a workspace.

Creates a lead (leads:write). For an imported walk-up or in-person customer, the integration may pass through a verified SMS opt-in by sending phone, sms_consent: true, and consent_language containing the exact disclosure the customer accepted. smsConsent, sms_opt_in, and text_consent are accepted aliases; consent: true asserts both SMS and voice consent. KaiCalls stores the disclosure and import source as consent provenance. Do not set an opt-in field unless the source system has verified the customer accepted that disclosure. A phone number alone remains cold and SMS is blocked, except for businesses explicitly configured for documented web-form implied consent. The 201 response includes consent ({ recorded, basis, channel }) whenever phone is supplied; send a portal invite only when consent.recorded is true.

post/v1/leads

Request

  • Base URL: https://www.kaicalls.com/api
  • URL: https://www.kaicalls.com/api/v1/leads
  • Auth: HTTP bearer

Request body

business_idstring uuid required
namestring
emailstring
phonestring

E.164 preferred; normalized on write.

sourcestring
sms_consentboolean

Attests that the source system verified this customer explicitly opted in to SMS. For imported walk-up clients, send true with consent_language. Never set this merely because a phone number is present.

consent_languagestring

Exact SMS consent disclosure accepted by the customer. Stored with the capture source as proof/provenance.

Response

Lead created (includes a consent object when a phone was supplied).

Changes

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