Update a client status

PUT /api/v1/client-status/{clientStatus_uuid}
Personal access token & OAuth2
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/clientStatus_uuid \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Inactive","colour":"#FFFFFF"}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Inactive",
  "colour": "#FFFFFF"
}
Response examples (200) 
{
  "name": "On Hold",
  "uuid": "cb51f24f-1240-4f53-ab35-e08e9e0e6591",
  "colour": "#FFFFFF",
  "created_at": "2025-02-20T10:13:02+00:00",
  "updated_at": "2025-02-20T10:13:02+00:00"
}