Cakemail API

Tags

Endpointhttps://api.cakemail.dev

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

Show a Contact Tag › Responses

Successful Response

object · required

GET/tags/{tag}

curl --request GET \
  --url https://api.cakemail.dev/tags/:tag

shell

Example Responses

{
  "data": {
    "tag": "tag"
  }
}

json

application/json

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

Delete a Contact Tag › Responses

Successful Response

tag

string · required

Tag value

object

string

Object type

Default: tag

deleted

boolean

Whether the tag was deleted

Default: true

DELETE/tags/{tag}

curl --request DELETE \
  --url https://api.cakemail.dev/tags/:tag

shell

Example Responses

{
  "tag": "tag",
  "object": "object",
  "deleted": true
}

json

application/json

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

Edit a Contact Tag › Request Body

tag

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

Edit a Contact Tag › Responses

Successful Response

tag

string · required

Tag value

object · required

object

string

Object type

Default: tag

updated

boolean

Whether the tag was updated

Default: true

PATCH/tags/{tag}

curl --request PATCH \
  --url https://api.cakemail.dev/tags/:tag \
  --header 'Content-Type: application/json' \
  --data '{
  "tag": "tag"
}'

shell

Example Request Body

{
  "tag": "tag"
}

json

Example Responses

{
  "tag": "tag",
  "object": "object",
  "updated": true,
  "data": {
    "tag": "tag"
  }
}

json

application/json

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

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

List Contact Tags › Responses

Successful Response

object · required

object[] · required

List of tags

GET/tags

curl --request GET \
  --url https://api.cakemail.dev/tags

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "tag": "tag"
    }
  ]
}

json

application/json

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

Create a Contact Tag › Request Body

tag

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

Create a Contact Tag › Responses

Successful Response

tag

string · required

Tag value

object

string

Object type

Default: tag

created

boolean

Whether the tag was created

Default: true

object

POST/tags

curl --request POST \
  --url https://api.cakemail.dev/tags \
  --header 'Content-Type: application/json' \
  --data '{
  "tag": "tag"
}'

shell

Example Request Body

{
  "tag": "tag"
}

json

Example Responses

{
  "tag": "tag",
  "object": "object",
  "created": true,
  "data": {
    "tag": "tag"
  }
}

json

application/json

Custom Attribute Report

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

Show a Contact Tag › Responses

Successful Response

object · required

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

Delete a Contact Tag › Responses

Successful Response

tag

string · required

Tag value

object

string

Object type

Default: tag

deleted

boolean

Whether the tag was deleted

Default: true

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

Edit a Contact Tag › Request Body

tag

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

Edit a Contact Tag › Responses

Successful Response

tag

string · required

Tag value

object · required

object

string

Object type

Default: tag

updated

boolean

Whether the tag was updated

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

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

List Contact Tags › Responses

Successful Response

object · required

object[] · 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

Create a Contact Tag › Request Body

tag

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

Create a Contact Tag › Responses

Successful Response

tag

string · required

Tag value

object

string

Object type

Default: tag

created

boolean

Whether the tag was created

Default: true

object