Skip to main content
POST
Ingest a client into a pipeline

Autorizaciones

Authorization
string
header
requerido

API key created in the dashboard under Settings → API Keys. Send it as Authorization: Bearer pk_....

Parámetros de ruta

input_node_uuid
string
requerido

UUID of the pipeline's API input node. Copy it from the input node's settings in the Salesflow editor.

Cuerpo

application/json

Request schema for ingesting a client into a Salesflow pipeline.

client_id
integer | null

ID of an existing client. Either this or phone_number is required.

phone_number
string | null

Phone number, preferably E.164. The client is looked up by it and created when not found.

first_name
string | null

Given name (used on create, or on update when update=true).

last_name
string | null

Family name.

email
string | null

Email address.

company
string | null

Company or organization name.

timezone
string | null

IANA timezone of the contact, e.g. America/Bogota.

area_code
string | null

Country calling code stored alongside the phone number.

data
Data · object | null

Free-form custom fields, available to agents as prompt variables.

update
boolean
predeterminado:false

When the client already exists, overwrite its stored fields with the values sent.

Respuesta

OK

Success response for Salesflow client ingestion.

status
string
requerido

Response status

Allowed value: "success"
client_id
integer
requerido

ID of the client

pipeline_id
integer
requerido

ID of the pipeline

stage_id
integer
requerido

ID of the target stage

message
string
requerido

Human-readable message