Create a client status

POST /api/v1/client-status

Personal access token & O auth2

application/json

Body Required

name string Required

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

POST /api/v1/client-status

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/client-status' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"Active","colour":"#FFFFFF"}'

Request examples

{
  "name": "Active",
  "colour": "#FFFFFF"
}

Response examples (200)

{
  "name": "On Hold",
  "uuid": "203c0e51-4cce-4cdf-b2cd-6cc09e597a1b",
  "colour": "#FFFFFF",
  "created_at": "2025-07-17T16:23:20+01:00",
  "updated_at": "2025-07-17T16:23:20+01:00"
}