Create stage template

Create a sub-step definition for a (entityType, status) stage. status and stepKey normalize to slug keys. entityType picks the transition that fires it: issue.status, deal.stage, or the customer’s status name.

POST/workspaces/{organizationId}/stage-templates

Path parameters

organizationIdstringrequired

Request body

application/json

entityTypestring

Allowed:issuedealcustomer

statusstringrequired

min length 1

stepKeystringrequired

min length 1

titlestringrequired

min length 1

requiredboolean

ownerAgentstring | null

conditionobject | null

Optional gate — {field} creates the step only when the record's field (column or custom field) is truthy; {field, equals} compares for equality. Field names normalize: "Hardware needed" == "hardware_needed".

Show properties

fieldstringrequired

min length 1

equalsstring | number | boolean

Show properties

Any of:

string

string

number

number

boolean

boolean

positioninteger

teamIdstring | null

Responses

201

Stage template created

templateStageTemplaterequired

Show properties

idstringrequired

organizationIdstringrequired

entityTypestringrequired

Allowed:issuedealcustomer

statusstringrequired

stepKeystringrequired

titlestringrequired

requiredbooleanrequired

ownerAgentstring | nullrequired

conditionobject | nullrequired

Show properties

fieldstringrequired

min length 1

equalsstring | number | boolean

Show properties

Any of:

string

string

number

number

boolean

boolean

positionintegerrequired

teamIdstring | nullrequired

createdBystring | nullrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST '/workspaces/string/stage-templates' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "entityType": "issue",
  "status": "string",
  "stepKey": "string",
  "title": "string",
  "required": true,
  "ownerAgent": "string",
  "condition": {
    "field": "string",
    "equals": "string"
  },
  "position": 0,
  "teamId": "string"
}'

const response = await fetch("/workspaces/string/stage-templates", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"entityType\": \"issue\",\n  \"status\": \"string\",\n  \"stepKey\": \"string\",\n  \"title\": \"string\",\n  \"required\": true,\n  \"ownerAgent\": \"string\",\n  \"condition\": {\n    \"field\": \"string\",\n    \"equals\": \"string\"\n  },\n  \"position\": 0,\n  \"teamId\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/stage-templates",
    headers={
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"entityType\": \"issue\",\n  \"status\": \"string\",\n  \"stepKey\": \"string\",\n  \"title\": \"string\",\n  \"required\": true,\n  \"ownerAgent\": \"string\",\n  \"condition\": {\n    \"field\": \"string\",\n    \"equals\": \"string\"\n  },\n  \"position\": 0,\n  \"teamId\": \"string\"\n}",
)

Response

{
  "template": {
    "id": "string",
    "organizationId": "string",
    "entityType": "issue",
    "status": "string",
    "stepKey": "string",
    "title": "string",
    "required": true,
    "ownerAgent": "string",
    "condition": {
      "field": "string",
      "equals": "string"
    },
    "position": 0,
    "teamId": "string",
    "createdBy": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}