LeadSafeCreate

Payload for creating or replacing a lead. Unknown fields are rejected.

product_idProduct Idrequired

ID of the product the lead will belong to. Required.

stage_idStage Idrequired

ID of the initial pipeline stage. Required.

stage_set_at object

Optional override for when the lead entered the stage; defaults to now.

anyOf

• date-time
• null

date-time

name object

Optional display name.

anyOf

• string
• null

string

crm_id object

Identifier of the matching record in the connected external CRM, if any.

anyOf

• string
• null

string

crm_fields object

Optional initial CRM key/value attributes.

property name* object

anyOf

• string
• integer
• number
• boolean
• string[]
• object

string

is_testIs Test

Create the lead as a test lead (excluded from production metrics).

Default value: false

batch_name object

Optional batch label.

anyOf

• string
• null

string

timezone object

Optional IANA timezone used for scheduling.

anyOf

• string
• null

string

status object

Optional free-form status string.

anyOf

• string
• null

string

is_activeIs Active

Whether the lead starts active. Defaults to true.

Default value: true

from_crm_integration_id object

If set, the lead is registered as imported from this CRM integration (must exist).

anyOf

• integer
• null

integer

from_pipeline_id object

Optional source CRM pipeline identifier.

anyOf

• string
• null

string

LeadSafeCreate

{
  "product_id": 0,
  "stage_id": 0,
  "stage_set_at": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "crm_id": "string",
  "crm_fields": {},
  "is_test": false,
  "batch_name": "string",
  "timezone": "string",
  "status": "string",
  "is_active": true,
  "from_crm_integration_id": 0,
  "from_pipeline_id": "string"
}