Skip to main content
POST
Push a record into the tenant CRM

Authorizations

Authorization
string
header
required

Tenant-issued API key. Format: vapk_live_<48 hex chars> (60 chars total). Issue + manage at /settings/integrations/api-keys in the Vorel dashboard. Each key has a scope set (read, leads:write, appointments:write, offerings:write); endpoints requiring a write scope reject keys without it with a 403 envelope.

Body

application/json
object
enum<string>
required
Available options:
contact,
lead,
deal,
appointment,
case
fields
object
required

Canonical Vorel field names (snake_case). Per-tenant tenant_crm_field_mappings translate these to the CRM-vendor key shape before the driver call.

idempotency_key
string
required
Required string length: 1 - 200

Response

CRM call completed (success OR typed soft-failure envelope).

ok
enum<boolean>
required
Available options:
true
external_id
string
required
record_url
string<uri>