Ana içeriğe atla
POST
Move a lead card on the board

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Yol Parametreleri

id
integer
gerekli

The lead identifier

Gövde

application/json
pipeline_stage_id
integer | null

The stage to move the card to; defaults to the lead's current stage (a reorder within the stage).

after_lead_id
integer | null

The lead the card goes right below (its new upper neighbour on the board). Must be in the target stage.

before_lead_id
integer | null

The lead the card goes right above (its new lower neighbour on the board). Must be in the target stage. Without either neighbour the card goes to the bottom of the stage.

lost_reason
string | null

The reason the lead was lost. Required when moving into a lost stage that mandates a reason.

lost_reason_id
integer | null

The clinic's lost reason (from GET /leads/lost-reasons) the lead was lost with.

Yanıt

success
string
gerekli
data
LeadResource · object
gerekli