Create a client status

POST /api/v1/client-status
Personal access token & OAuth2

Headers

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 {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"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": "4c389782-093b-4bc0-a8bb-a9041039aac5",
  "colour": "#FFFFFF",
  "created_at": "2025-02-20T10:13:02+00:00",
  "updated_at": "2025-02-20T10:13:02+00:00"
}