Create CRM process stage

POST/v1/crm/lists/{listID}/stages

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

listIDstringrequired

Request body

requiredapplication/json

colorstring

display_orderinteger<int32>

is_defaultboolean

metadataany

namestringrequired

slugstring

Responses

200OK

colorstring | nullrequired

created_atstringrequired

display_orderinteger<int32>required

idstringrequired

is_archivedbooleanrequired

is_defaultbooleanrequired

list_idstringrequired

metadataanyrequired

namestringrequired

slugstringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/crm/lists/string/stages" \
  -H "Content-Type: application/json" \
  -d '{
  "color": "string",
  "display_order": 0,
  "is_default": true,
  "metadata": "string",
  "name": "string",
  "slug": "string"
}'

const response = await fetch("/v1/crm/lists/string/stages", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "color": "string",
  "display_order": 0,
  "is_default": true,
  "metadata": "string",
  "name": "string",
  "slug": "string"
})
});

import requests

response = requests.post(
    "/v1/crm/lists/string/stages",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "color": "string",
  "display_order": 0,
  "is_default": True,
  "metadata": "string",
  "name": "string",
  "slug": "string"
},
)

Response

{
  "color": "string",
  "created_at": "string",
  "display_order": 0,
  "id": "string",
  "is_archived": true,
  "is_default": true,
  "list_id": "string",
  "metadata": "string",
  "name": "string",
  "slug": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}