Skip to content

Rename or recolour a label

PATCH
/v1/changelog/labels/{label_id}

Changing the slug changes filter links and what subscribers’ saved slugs mean; entries and subscribers keep the label itself.

Auth: Secret key only. The dashboard has the same operation under /v1/dashboard/changelog.

label_id
required
string
object
name
string
>= 1 characters <= 40 characters
slug
string
/^[a-z0-9](?:[a-z0-9-]{0,38}[a-z0-9])?$/
colour
string
Allowed values: gray red orange amber green teal blue indigo purple pink

The label

object
data
object
id
string
Example
cll_01J...
slug
string
Example
mobile
name
string
colour
string
Allowed values: gray red orange amber green teal blue indigo purple pink
error
null
meta
object

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties