Skip to main content
POST

Authorizations

Authorization
string
header
required

API key from Settings → API Keys in your workspace

Body

application/json
workflow_id
string
required

Journey ID from your workspace URL (not the Flow ID)

Example:

"98249779-79ae-462f-a0cf-7ce5129cc093"

record
object

Lead data for creating a new lead. Provide this OR lead_id, not both.

lead_id
string

Existing lead UUID. Provide this OR record, not both.

Example:

"307fc241-8398-4740-8122-cf6a59f3b86e"

Response

Lead enrolled successfully

status
string
Example:

"success"

lead_id
string
Example:

"307fc241-8398-4740-8122-cf6a59f3b86e"

workflow_assigned
boolean
Example:

true

message
string
Example:

"Lead successfully added to workflow"