Update a client status

PUT /api/v1/client-status/{clientStatus_uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

clientStatus_uuid string Required

application/json

Body

name string

The name of the status.
colour string

The colour of the status.

Responses

200 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 custom status.
- colour string
  
  The colour of the custom status

PUT /api/v1/client-status/{clientStatus_uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/client-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":"Inactive","colour":"#FFFFFF"}'

Request examples

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

# Payload
{
  "name": "Inactive",
  "colour": "#FFFFFF"
}

Response examples (200)

{
  "name": "On Hold",
  "uuid": "f94e200b-dc2e-4f88-80d1-c2d990d3ee44",
  "colour": "#FFFFFF",
  "created_at": "2025-06-25T15:10:42+01:00",
  "updated_at": "2025-06-25T15:10:42+01:00"
}