Update a label
Changes the title, description, colour or sidebar visibility. Renaming a label re-tags every conversation and contact that carries it, in a background job — the rename returns immediately and the re-tagging follows, so a read straight afterwards can still show the old title.
Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the label.
4
Body
The label to create or update.
Response
Success
A label. title — not id — is the identifier every other endpoint uses: the conversation and contact label endpoints take and return titles.
The numeric ID of the label.
The label text, lower-cased on save. Unique within the account.
Internal note about when to apply the label. Not shown to contacts.
Hex colour used for the label chip, including the leading #.
Whether the label gets its own filtered view in the dashboard sidebar.