Fields
List the fields of a pipeline
In the order the pipeline declares them.
Required scope: pipelines:read.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
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 the fields of a pipeline › Responses
Create a field
A field holds a piece of data of the case. Select fields carry their options; a select can depend on another select.
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.
Create a field › Request Body
key^[A-Za-z][A-Za-z0-9_… · requiredLetters, numbers and underscores, starting with a letter. Unique in the pipeline and fixed once created.
typelabelDefaults to the key.
requiredOnly for type select.
dependsOnThe key of a select field this one depends on. One level only.
sourceWho fills it: the team, the channel, your system or the agent.
instructionWhat the agent should ask or look for.
sensitiveHides its value from the agent and from webhooks.
Create a field › Responses
objectidpipelineIdkeylabeltyperequireddependsOnsourceinstructionsensitivecreatedAtupdatedAtRetrieve a field
Returns one field of a pipeline by id. Use it to refresh a single record you already know; to find records, use the list route. 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_…).
fieldId^fld_[0-9A-Za-z]{22}… · requiredThe id of the field (fld_…).
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 field › Responses
objectidpipelineIdkeylabeltyperequireddependsOnsourceinstructionsensitivecreatedAtupdatedAtDelete a field
Answers 409 resource_in_use while another field depends on it. It stops being required in the stages that asked for it.
Required scope: pipelines:write.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
fieldId^fld_[0-9A-Za-z]{22}… · requiredThe id of the field (fld_…).
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 field › Responses
Update a field
The key and the type are fixed. options replaces the list; cases keep the values they already have.
Required scope: pipelines:write.
path Parameters
id^ppl_[0-9A-Za-z]{22}… · requiredThe id of the pipeline (ppl_…).
fieldId^fld_[0-9A-Za-z]{22}… · requiredThe id of the field (fld_…).
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 field › Request Body optional
labelrequiredReplaces the options. Cases keep the values they have.
dependsOnsourceinstructionsensitiveUpdate a field › Responses
objectidpipelineIdkeylabeltyperequireddependsOnsourceinstructionsensitivecreatedAtupdatedAt