Cakemail API

Campaign Blueprint

Endpointhttps://api.cakemail.dev

Browse pre-built campaign blueprints. Blueprints are ready-made campaign designs that can be used as starting points for new campaigns.

Show all campaign blueprints

GET

https://api.cakemail.dev

/campaign-blueprints

List all available campaign blueprints. Blueprints are pre-built campaign designs that can be used as starting points.

Required scope(s): campaign_blueprints:read

Show all campaign blueprints › query Parameters

account_id

integer · min: 1

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

filter

string

Valid Terms:

tag
not_tag
name
is_owner
is_not_owner

Valid Operators:

==

Query separator:

Valid Terms:

tag
not_tag
name
is_owner
is_not_owner

Valid Operators:

==

Query separator:

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

id
created_on
updated_on
name

Sort term and direction, using syntax [-|+]term.

Valid terms:

id
created_on
updated_on
name

Default: id

Show all campaign blueprints › Responses

Successful Response

object · required

object[] · required

GET/campaign-blueprints

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

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "name": "name",
      "description": "description",
      "created_on": 0,
      "updated_on": 0,
      "tags": [
        "string"
      ],
      "thumbnail": "thumbnail",
      "thumbnail_url": "thumbnail_url"
    }
  ]
}

json

application/json

Get a campaign blueprint

GET

https://api.cakemail.dev

/campaign-blueprints/{blueprint_id}

Retrieve the full details of a campaign blueprint, including its content and metadata.

Required scope(s): campaign_blueprints:read

Get a campaign blueprint › path Parameters

blueprint_id

integer · required

Get a campaign blueprint › query Parameters

account_id

integer · min: 1

Get a campaign blueprint › Responses

Successful Response

object · required

GET/campaign-blueprints/{blueprint_id}

curl --request GET \
  --url https://api.cakemail.dev/campaign-blueprints/:blueprint_id

shell

Example Responses

{
  "data": {
    "id": 0,
    "name": "name",
    "description": "description",
    "created_on": 0,
    "updated_on": 0,
    "tags": [
      "string"
    ],
    "is_owner": true,
    "sharing": {
      "shared": true,
      "accounts": [
        {
          "account_id": 0,
          "visible": true,
          "company_name": "company_name"
        }
      ],
      "automatic": true
    },
    "thumbnail": "thumbnail",
    "thumbnail_url": "thumbnail_url",
    "content": {
      "type": "html",
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {}
    }
  }
}

json

application/json

Render campaign blueprint

GET

https://api.cakemail.dev

/campaign-blueprints/{blueprint_id}/render

Render a campaign blueprint's HTML content for preview.

Required scope(s): campaign_blueprints:read

Render campaign blueprint › path Parameters

blueprint_id

integer · required

Render campaign blueprint › Responses

Successful Response

string

GET/campaign-blueprints/{blueprint_id}/render

curl --request GET \
  --url https://api.cakemail.dev/campaign-blueprints/:blueprint_id/render

shell

Example Responses

string

html

text/html

Campaign Template

Show all campaign blueprints

GET

https://api.cakemail.dev

/campaign-blueprints

List all available campaign blueprints. Blueprints are pre-built campaign designs that can be used as starting points.

Required scope(s): campaign_blueprints:read

Show all campaign blueprints › query Parameters

account_id

integer · min: 1

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

filter

string

Valid Terms:

tag
not_tag
name
is_owner
is_not_owner

Valid Operators:

==

Query separator:

Valid Terms:

tag
not_tag
name
is_owner
is_not_owner

Valid Operators:

==

Query separator:

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

id
created_on
updated_on
name

Sort term and direction, using syntax [-|+]term.

Valid terms:

id
created_on
updated_on
name

Default: id

Show all campaign blueprints › Responses

Successful Response

object · required

object[] · required

Get a campaign blueprint

GET

https://api.cakemail.dev

/campaign-blueprints/{blueprint_id}

Retrieve the full details of a campaign blueprint, including its content and metadata.

Required scope(s): campaign_blueprints:read

Get a campaign blueprint › path Parameters

blueprint_id

integer · required

Get a campaign blueprint › query Parameters

account_id

integer · min: 1

Get a campaign blueprint › Responses

Successful Response

object · required

{ "data": { "id": 0, "name": "name", "description": "description", "created_on": 0, "updated_on": 0, "tags": [ "string" ], "is_owner": true, "sharing": { "shared": true, "accounts": [ { "account_id": 0, "visible": true, "company_name": "company_name" } ], "automatic": true }, "thumbnail": "thumbnail", "thumbnail_url": "thumbnail_url", "content": { "type": "html", "subject": "subject", "html": "html", "text": "text", "json": {} } } }

Render campaign blueprint

GET

https://api.cakemail.dev

/campaign-blueprints/{blueprint_id}/render

Render a campaign blueprint's HTML content for preview.

Required scope(s): campaign_blueprints:read

Render campaign blueprint › path Parameters

blueprint_id

integer · required

Render campaign blueprint › Responses

Successful Response

string