Pipelines
List pipelines
Lists the pipelines of the organization, each with its stages. Use it to find where a case can start; read a stage or a field with their own routes. Read only. It is safe to repeat.
Required scope: pipelines:read.
query Parameters
limitcursorThe nextCursor of the previous page, with the same filters.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
List pipelines › Responses
objecthasMorenextCursorCreate a pipeline
Creates the pipeline active. Send stages to create them in the same call, in order; the entry stage is the one marked entry, or the first. Link an agent to a stage with agentId.
Required scope: pipelines:write.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Create a pipeline › Request Body
namedescriptionCreate stages in the same call, in order.
Settings of the pipeline. A stage cannot be named here because the pipeline has none yet: set stageOnTakeControl, stageOnHandoff and autoClose.closeStageId with PATCH.
Create a pipeline › Responses
objectidnamedescriptionstatusstagesThe ids of its stages, in order.
createdAtupdatedAtRetrieve a pipeline
Returns one pipeline by id. Use it to refresh a single record you already know; to find records, use the list route. Stages, fields and routing rules have their own routes under it. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.
Required scope: pipelines:read.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Retrieve a pipeline › Responses
objectidnamedescriptionstatusstagesThe ids of its stages, in order.
createdAtupdatedAtDelete a pipeline
Answers 409 resource_in_use while it has open cases. The agents linked to its stages are not deleted.
Required scope: pipelines:write.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Delete a pipeline › Responses
Update a pipeline
quickReplies replaces the whole list. Stages are changed on their own routes.
Required scope: pipelines:write.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Update a pipeline › Request Body optional
namedescriptionstatusReplaces the whole list. An empty list removes them all.
Only the settings you send change. Each block (autoClose, businessHours, waitThresholds) replaces the whole block, and null removes a setting.
Update a pipeline › Responses
objectidnamedescriptionstatusstagesThe ids of its stages, in order.
createdAtupdatedAtClone a pipeline
Copies the pipeline under a new name: its stages with their agents, required fields, transitions and settings, and its quick replies. The clone is a draft and keeps no case; set its status to active with PATCH when it is ready. Stage ids are new, and the transitions of the clone point to the new stages.
Required scope: pipelines:write.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Clone a pipeline › Responses
objectidnamedescriptionstatusstagesThe ids of its stages, in order.
createdAtupdatedAtReorder the stages of a pipeline
Send every stage of the pipeline in the order you want. All positions change in one operation: if the list misses a stage, repeats one or holds a stage of another pipeline, it is a 400 with param stages and nothing changes. The entry stage does not change. Returns the pipeline with its stages in the new order.
Required scope: pipelines:write.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Reorder the stages of a pipeline › Request Body
stagesEvery stage of the pipeline, once each, in the order they should have: the first one takes position 0. A stage that is missing, repeated or from another pipeline is a 400 with param stages and nothing changes.
Reorder the stages of a pipeline › Responses
objectidnamedescriptionstatusstagesThe ids of its stages, in order.
createdAtupdatedAt