Create a client status

POST /api/v1/client-status

Headers

Authorization string
Content-Type string
Accept string

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 \
 -X POST https://api.plannrcrm.com/api/v1/client-status \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"name":"Active","colour":"#FFFFFF"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

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

Response examples (200)

{
  "name": "On Hold",
  "uuid": "e2deeb73-5758-4f21-994e-34dd8f9f48d2",
  "colour": "#FFFFFF",
  "created_at": "2024-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01:00"
}