Update a task status

PUT /api/v1/task-status/{taskStatus_uuid}

Personal access token & O auth2

You cannot update a completed statuses details except it's position

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

taskStatus_uuid string Required

application/json

Body

name string

Name of the task status
colour string

Colour of the task status
position integer

Position 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

PUT /api/v1/task-status/{taskStatus_uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/task-status/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Incomplete","colour":"#ff0000","position":1}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

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

Response examples (201)

{
  "name": "Incomplete",
  "uuid": "ba439be6-fc7d-49c0-90d0-3a06105a0c51",
  "colour": "#398898",
  "position": 1,
  "created_at": "2025-07-17T16:23:21+01:00",
  "updated_at": "2025-07-17T16:23:21+01:00",
  "is_archived": false,
  "is_not_started": false,
  "is_type_completed": false
}