PUT
/v1/definitions/{key}/transition-formsSet what one move asks for
REPLACES the field list for one trigger — a status value, or convert for the lead-to-deal handoff. Each field names a real column on this page and may be marked required, which refuses the move until it is filled. An empty list removes the form.
Access class: def:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
keypath · stringrequired
Request body
application/jsonrequiredbodyoptional
paramsoptional
queryobjectoptional
Responses
200application/json
the action's answer
{
"data": {
"fields": [
"string"
],
"trigger": "string",
"value": "string"
}
}datarequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired