Create a task status

POST /api/v1/task-status

Personal access token & O auth2

Headers

application/json

Body Required

name string Required

Name of the task status
colour string

Colour of the task status

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  The name of the status
- colour string
  
  Status colour
- position integer
  
  The position of the status
- is_type_completed boolean
  
  Whether the status is a completed status
- is_archived boolean
  
  Whether the status is a archived status
- is_not_started boolean
  
  Whether the status is a not started status

POST /api/v1/task-status

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/task-status' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Incomplete","colour":"#ff0000"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Incomplete",
  "colour": "#ff0000"
}

Response examples (201)

{
  "name": "Incomplete",
  "uuid": "b6e356b0-dfc7-4ef4-9a65-dc153a1751db",
  "colour": "#398898",
  "position": 1,
  "created_at": "2025-05-14T18:27:13+01:00",
  "updated_at": "2025-05-14T18:27:13+01:00",
  "is_archived": false,
  "is_not_started": false,
  "is_type_completed": false
}