Cakemail API

Account

Endpointhttps://api.cakemail.dev

Manage the authenticated user's own account. An account represents an organization on the platform with its own contacts, campaigns, and settings. Use these endpoints to view or update account details, address, and domains. To manage sub-accounts under a partner account, see the Sub-Account endpoints.

Show my account details

GET

https://api.cakemail.dev

/accounts/self

Retrieve the full details of the authenticated user's account, including name, address, contact information, usage limits, feature flags, and domain configuration.

Show my account details › Responses

Successful Response

object · required

GET/accounts/self

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

shell

Example Responses

{
  "data": {
    "id": "id",
    "lineage": "lineage",
    "status": "trial",
    "name": "name",
    "address": {
      "address1": "address1",
      "address2": "address2",
      "city": "city",
      "country": "country",
      "province": "province",
      "postal_code": "postal_code"
    },
    "account_owner": {
      "user_id": "user_id"
    },
    "fax": "fax",
    "phone": "phone",
    "website": "website",
    "logo": "logo",
    "usage_limits": {
      "starts_on": 0,
      "per_campaign": 0,
      "per_month": 0,
      "remaining": 0,
      "maximum_contacts": 0,
      "lists": 0,
      "users": 0,
      "campaign_blueprints": 0,
      "automation_conditions": 0,
      "use_ab_split": true,
      "use_automation_conditions": true,
      "use_automations": true,
      "use_automation_customwebhooks": true,
      "use_behavioral_segmentation": true,
      "use_brand": true,
      "use_campaign_blueprints": true,
      "use_contact_export": true,
      "use_custom_merge_tags": true,
      "use_email_api": true,
      "use_html_editor": true,
      "use_list_redirection": true,
      "use_smart_email_resource": true,
      "use_smart_blueprint": true,
      "use_tags_in_automation": true,
      "use_tags": true,
      "insert_reseller_logo": true,
      "use_forms": true,
      "use_popups": true,
      "use_pages": true,
      "use_pages_redirection": true,
      "use_ai_generation": true
    },
    "last_activity_on": 0,
    "created_on": 0,
    "partner": true,
    "organization": true,
    "stripe_customer_id": "stripe_customer_id",
    "overrides": {
      "bypass_recaptcha": true,
      "inject_address": true,
      "inject_unsubscribe_link": true
    },
    "metadata": {}
  }
}

json

application/json

Update my account

PATCH

https://api.cakemail.dev

/accounts/self

Update the authenticated user's account. All fields are optional — only provided fields are updated. The address is validated against a geocoding service; if the provided address differs from the geocoded result, warnings with suggested corrections are included in the response.

Update my account › Request Body

object

name

string

Account display name

object

fax

string

phone

string

object

website

string · uri · minLength: 1 · maxLength: 2083

Account website URL

Update my account › Responses

Successful Response

object · required

object[]

Default: []

PATCH/accounts/self

curl --request PATCH \
  --url https://api.cakemail.dev/accounts/self \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "address1": "address1",
    "address2": "address2",
    "city": "city",
    "country": "country",
    "province": "province",
    "postal_code": "postal_code"
  },
  "name": "name",
  "account_owner": {
    "user_id": 0
  },
  "fax": "fax",
  "phone": "phone",
  "domains": {
    "bounce": "bounce",
    "tracking": "https://www.example.com/path/to/resource",
    "forward": "https://www.example.com/path/to/resource"
  },
  "website": "https://www.example.com/path/to/resource"
}
'

shell

Example Request Body

{
  "address": {
    "address1": "address1",
    "address2": "address2",
    "city": "city",
    "country": "country",
    "province": "province",
    "postal_code": "postal_code"
  },
  "name": "name",
  "account_owner": {
    "user_id": 0
  },
  "fax": "fax",
  "phone": "phone",
  "domains": {
    "bounce": "bounce",
    "tracking": "https://www.example.com/path/to/resource",
    "forward": "https://www.example.com/path/to/resource"
  },
  "website": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "lineage": "lineage",
    "status": "trial",
    "name": "name",
    "address": {
      "address1": "address1",
      "address2": "address2",
      "city": "city",
      "country": "country",
      "province": "province",
      "postal_code": "postal_code"
    },
    "account_owner": {
      "user_id": "user_id"
    },
    "fax": "fax",
    "phone": "phone",
    "website": "website",
    "logo": "logo",
    "usage_limits": {
      "starts_on": 0,
      "per_campaign": 0,
      "per_month": 0,
      "remaining": 0,
      "maximum_contacts": 0,
      "lists": 0,
      "users": 0,
      "campaign_blueprints": 0,
      "automation_conditions": 0,
      "use_ab_split": true,
      "use_automation_conditions": true,
      "use_automations": true,
      "use_automation_customwebhooks": true,
      "use_behavioral_segmentation": true,
      "use_brand": true,
      "use_campaign_blueprints": true,
      "use_contact_export": true,
      "use_custom_merge_tags": true,
      "use_email_api": true,
      "use_html_editor": true,
      "use_list_redirection": true,
      "use_smart_email_resource": true,
      "use_smart_blueprint": true,
      "use_tags_in_automation": true,
      "use_tags": true,
      "insert_reseller_logo": true,
      "use_forms": true,
      "use_popups": true,
      "use_pages": true,
      "use_pages_redirection": true,
      "use_ai_generation": true
    },
    "last_activity_on": 0,
    "created_on": 0,
    "partner": true,
    "organization": true,
    "stripe_customer_id": "stripe_customer_id",
    "overrides": {
      "bypass_recaptcha": true,
      "inject_address": true,
      "inject_unsubscribe_link": true
    },
    "metadata": {}
  },
  "warnings": [
    {}
  ]
}

json

application/json

Convert my account to an Organization

POST

https://api.cakemail.dev

/accounts/self/convert-to-organization

Convert the authenticated user's account into an organization. An organization account can create and manage sub-accounts, each with their own users, contacts, and campaigns. This operation is irreversible.

Convert my account to an Organization › Responses

Successful Response

object · required

POST/accounts/self/convert-to-organization

curl --request POST \
  --url https://api.cakemail.dev/accounts/self/convert-to-organization

shell

Example Responses

{
  "data": {
    "id": "id",
    "lineage": "lineage",
    "status": "trial",
    "name": "name",
    "address": {
      "address1": "address1",
      "address2": "address2",
      "city": "city",
      "country": "country",
      "province": "province",
      "postal_code": "postal_code"
    },
    "account_owner": {
      "user_id": "user_id"
    },
    "fax": "fax",
    "phone": "phone",
    "website": "website",
    "logo": "logo",
    "usage_limits": {
      "starts_on": 0,
      "per_campaign": 0,
      "per_month": 0,
      "remaining": 0,
      "maximum_contacts": 0,
      "lists": 0,
      "users": 0,
      "campaign_blueprints": 0,
      "automation_conditions": 0,
      "use_ab_split": true,
      "use_automation_conditions": true,
      "use_automations": true,
      "use_automation_customwebhooks": true,
      "use_behavioral_segmentation": true,
      "use_brand": true,
      "use_campaign_blueprints": true,
      "use_contact_export": true,
      "use_custom_merge_tags": true,
      "use_email_api": true,
      "use_html_editor": true,
      "use_list_redirection": true,
      "use_smart_email_resource": true,
      "use_smart_blueprint": true,
      "use_tags_in_automation": true,
      "use_tags": true,
      "insert_reseller_logo": true,
      "use_forms": true,
      "use_popups": true,
      "use_pages": true,
      "use_pages_redirection": true,
      "use_ai_generation": true
    },
    "last_activity_on": 0,
    "created_on": 0,
    "partner": true,
    "organization": true,
    "stripe_customer_id": "stripe_customer_id",
    "overrides": {
      "bypass_recaptcha": true,
      "inject_address": true,
      "inject_unsubscribe_link": true
    },
    "metadata": {}
  }
}

json

application/json

Token User

{ "data": { "id": "id", "lineage": "lineage", "status": "trial", "name": "name", "address": { "address1": "address1", "address2": "address2", "city": "city", "country": "country", "province": "province", "postal_code": "postal_code" }, "account_owner": { "user_id": "user_id" }, "fax": "fax", "phone": "phone", "website": "website", "logo": "logo", "usage_limits": { "starts_on": 0, "per_campaign": 0, "per_month": 0, "remaining": 0, "maximum_contacts": 0, "lists": 0, "users": 0, "campaign_blueprints": 0, "automation_conditions": 0, "use_ab_split": true, "use_automation_conditions": true, "use_automations": true, "use_automation_customwebhooks": true, "use_behavioral_segmentation": true, "use_brand": true, "use_campaign_blueprints": true, "use_contact_export": true, "use_custom_merge_tags": true, "use_email_api": true, "use_html_editor": true, "use_list_redirection": true, "use_smart_email_resource": true, "use_smart_blueprint": true, "use_tags_in_automation": true, "use_tags": true, "insert_reseller_logo": true, "use_forms": true, "use_popups": true, "use_pages": true, "use_pages_redirection": true, "use_ai_generation": true }, "last_activity_on": 0, "created_on": 0, "partner": true, "organization": true, "stripe_customer_id": "stripe_customer_id", "overrides": { "bypass_recaptcha": true, "inject_address": true, "inject_unsubscribe_link": true }, "metadata": {} } }

Update my account

PATCH

https://api.cakemail.dev

/accounts/self

Update my account › Request Body

object

name

string

Account display name

object

fax

string

phone

string

object

website

string · uri · minLength: 1 · maxLength: 2083

Account website URL

Update my account › Responses

Successful Response

object · required

object[]

Default: []

curl --request PATCH \ --url https://api.cakemail.dev/accounts/self \ --header 'Content-Type: application/json' \ --data ' { "address": { "address1": "address1", "address2": "address2", "city": "city", "country": "country", "province": "province", "postal_code": "postal_code" }, "name": "name", "account_owner": { "user_id": 0 }, "fax": "fax", "phone": "phone", "domains": { "bounce": "bounce", "tracking": "https://www.example.com/path/to/resource", "forward": "https://www.example.com/path/to/resource" }, "website": "https://www.example.com/path/to/resource" } '

{ "address": { "address1": "address1", "address2": "address2", "city": "city", "country": "country", "province": "province", "postal_code": "postal_code" }, "name": "name", "account_owner": { "user_id": 0 }, "fax": "fax", "phone": "phone", "domains": { "bounce": "bounce", "tracking": "https://www.example.com/path/to/resource", "forward": "https://www.example.com/path/to/resource" }, "website": "https://www.example.com/path/to/resource" }

Convert my account to an Organization

POST

https://api.cakemail.dev

/accounts/self/convert-to-organization

Convert my account to an Organization › Responses

Successful Response

object · required