Labels

Update a label

Update a label's attributes

patch/v1/workspaces/{workspace_id}/labels/{id}

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/labels/{id}
  • Auth: API key in header api_access_token

Request body

titlestring

The label title

descriptionstring

A short description for the label

colorstring

Hex color code for the label

show_on_sidebarboolean

Whether the label should appear in the sidebar

Example request

{
  "title": "support",
  "description": "Conversations that need support follow-up",
  "color": "#1f93ff",
  "show_on_sidebar": true
}

Response

Success

idnumber

The ID of the label

titlestring

The title of the label

descriptionstring

The description of the label

colorstring

Hex color code for the label

show_on_sidebarboolean

Whether the label should appear in the sidebar

Changes

No recorded changes to this operation across all 1 revision of this API.