Skip to main content
PATCH
Patch custom tag

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The ID of the item to update

Example:

"01a08b36-be29-7f92-8b40-991cfaca6d65"

Body

application/json
label
string

Display label for the custom tag. Must be unique per workspace after trimming whitespace.

Minimum string length: 1
Pattern: .*\S.*
Example:

"Important"

description
string | null

Detailed description of the custom tag purpose

Example:

"Used for marking important items"

Response

The updated Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

id
string<uuid>
required
read-only

Unique identifier for the custom tag

Example:

"01a08b36-69cf-7b13-a9de-4fa062193462"

timestamp_created
string<date-time>
required
read-only

Timestamp when the custom tag was created

Example:

"2026-09-10T12:06:34.191Z"

timestamp_updated
string<date-time>
required
read-only

Timestamp when the custom tag was last updated

Example:

"2026-09-10T12:06:34.191Z"

organization_id
string<uuid>
required
read-only

Organization ID that owns this custom tag

Example:

"01a08b36-69cf-7b13-a9de-4fa166fe72c2"

label
string
required

Display label for the custom tag. Must be unique per workspace after trimming whitespace.

Minimum string length: 1
Pattern: .*\S.*
Example:

"Important"

description
null | string

Detailed description of the custom tag purpose

Example:

"Used for marking important items"