Skip to main content
This schema describes objects returned by the Custom Tag Mapping endpoints.

This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (tag_id field) with the email account (resource_id field). You can use it to see which tag si connected to which resource.

​
id
string<uuid>
required
read-only

A Unique identifier

Example:

"01a16b40-814e-78b9-83ba-3f5b9da1d08b"

​
tag_id
string<uuid>
required
read-only

ID of the tag this custom mapping belongs to

Example:

"01a16b40-814f-76c7-a300-fb5125914c89"

​
resource_id
string<uuid>
required
read-only

ID of the resource custom tag mapping belongs to, resource_type determines the type of resource

Example:

"01a16b40-814f-76c7-a300-fb527a988f60"

​
resource_type
enum<number>
required
read-only

Resource type of custom tag: 1 for accounts, 2 for campaigns, 3 for workspaces

Available options:
1,
2,
3
Example:

1

​
timestamp_created
string<date-time>
required
read-only

Timestamp when the custom tag mapping was created

Example:

"2026-10-24T00:12:31.951Z"

​
organization_id
string<uuid>
required
read-only

Organization ID that owns this custom tag mapping

Example:

"01a16b40-814f-76c7-a300-fb53bb935353"