Create customer statuse

POST/workspaces/{organizationId}/customer-statuses

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

namestringrequired

min length 1

keystring

min length 1

typestring

Allowed:activeterminal

colorstring

positionnumber

Responses

201

Status created

idstringrequired

organizationIdstringrequired

namestringrequired

keystring | nullrequired

typestringrequired

colorstring | nullrequired

positionnumberrequired

createdAtstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

namestring*keystringtypestringcolorstringpositionnumber

Request

curl -X POST 'https://pile.nyc/workspaces/string/customer-statuses' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "key": "string",
  "type": "active",
  "color": "string",
  "position": 0
}'

const response = await fetch("https://pile.nyc/workspaces/string/customer-statuses", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"key\": \"string\",\n  \"type\": \"active\",\n  \"color\": \"string\",\n  \"position\": 0\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/customer-statuses",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"key\": \"string\",\n  \"type\": \"active\",\n  \"color\": \"string\",\n  \"position\": 0\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "key": "string",
  "type": "string",
  "color": "string",
  "position": 0,
  "createdAt": "string"
}