Cakemail
Cakemail API
Cakemail API

Tags

Manage contact tags for flexible organization and segmentation. Tags are simple labels that can be attached to contacts for grouping and filtering.

Show a Contact Tag

GET
https://api.cakemail.dev
/tags/{tag}

Retrieve the details of a contact tag.

Required scope(s): tags:read

Show a Contact Tag › path Parameters

tag
​string · minLength: 1 · maxLength: 64 · pattern: ^[A-Za-z0-9.\-+_]+$ · required

Show a Contact Tag › query Parameters

account_id
​integer · min: 1

Optional Account ID to be used for the request

Optional Account ID to be used for the request

Show a Contact Tag › Responses

Successful Response

TagResponse
​object · required

Tag details

Edit a Contact Tag

PATCH
https://api.cakemail.dev
/tags/{tag}

Update a contact tag's name.

Required scope(s): tags:write

Edit a Contact Tag › path Parameters

tag
​string · minLength: 1 · maxLength: 64 · pattern: ^[A-Za-z0-9.\-+_]+$ · required

Edit a Contact Tag › query Parameters

account_id
​integer · min: 1

Optional Account ID to be used for the request

Optional Account ID to be used for the request

Edit a Contact Tag › Request Body

PatchTag
tag
​string · minLength: 1 · maxLength: 64 · pattern: ^[A-Za-z0-9.\-+_]+$ · required

Edit a Contact Tag › Responses

Successful Response

PatchTagResponse
tag
​string · required

Tag value

​object · required

Updated tag details

object
​string

Object type

Default: tag
updated
​boolean

Whether the tag was updated

Default: true

Delete a Contact Tag

DELETE
https://api.cakemail.dev
/tags/{tag}

Delete a contact tag. The tag is removed from all contacts that had it.

Required scope(s): tags:delete

Delete a Contact Tag › path Parameters

tag
​string · minLength: 1 · maxLength: 64 · pattern: ^[A-Za-z0-9.\-+_]+$ · required

Delete a Contact Tag › query Parameters

account_id
​integer · min: 1

Optional Account ID to be used for the request

Optional Account ID to be used for the request

Delete a Contact Tag › Responses

Successful Response

DeleteTagResponse
tag
​string · required

Tag value

object
​string

Object type

Default: tag
deleted
​boolean

Whether the tag was deleted

Default: true

List Contact Tags

GET
https://api.cakemail.dev
/tags

List all contact tags in the account.

Required scope(s): tags:read

List Contact Tags › query Parameters

account_id
​integer · min: 1

Optional Account ID to be used for the request

Optional Account ID to be used for the request

page
​integer · min: 1
Default: 1
per_page
​integer · min: 1
Default: 50
with_count
​boolean

Include count in the response

Include count in the response

Default: false

List Contact Tags › Responses

Successful Response

TagsResponse
​object · required

Pagination metadata

​TagFullResponse[] · required

List of tags

Create a Contact Tag

POST
https://api.cakemail.dev
/tags

Create a new contact tag.

Required scope(s): tags:write

Create a Contact Tag › query Parameters

account_id
​integer · min: 1

Optional Account ID to be used for the request

Optional Account ID to be used for the request

Create a Contact Tag › Request Body

CreateTag
tag
​string · minLength: 1 · maxLength: 64 · pattern: ^[A-Za-z0-9.\-+_]+$ · required

Create a Contact Tag › Responses

Successful Response

CreateTagResponse
tag
​string · required

Tag value

object
​string

Object type

Default: tag
created
​boolean

Whether the tag was created

Default: true
​object

Created tag details

Custom AttributeReport