Skip to main content
POST
Add an item to pipeline

Authorizations

api_access_token
string
header
required

Path Parameters

pipeline_id
string<uuid>
required

Query Parameters

stage_id
string<uuid>

Filter by stage

Search by contact name, email, or conversation ID

sort_by
enum<string>
default:created_at
Available options:
created_at,
updated_at,
stage_name,
contact_name
sort_order
enum<string>
default:desc
Available options:
asc,
desc

Body

application/json
type
enum<string>
required

Type of item to add

Available options:
conversation,
contact
item_id
string
required

UUID of conversation or contact

pipeline_stage_id
string<uuid>

Stage ID (if not provided, uses first stage)

custom_fields
object

Custom field values

Response

Item added successfully

success
boolean
required
Example:

true

data
object
required
meta
object
required
message
string
required
Example:

"Pipeline item added successfully"