Sub-Account

Manage sub-accounts under a partner or organization account. Sub-accounts are independent accounts with their own users, contacts, and campaigns, managed by the parent account. Includes creation, suspension, and configuration.

Show all sub-accounts

GET

https://api.cakemail.dev

/accounts

List all sub-accounts under the authenticated partner or organization account.

Required scope(s): sub_accounts:read

Show all sub-accounts › query Parameters

partner_account_id

integer

recursive

boolean

Default: false

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

sort

string

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

Valid terms:

name
created_on

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

Valid terms:

name
created_on

filter

string

Valid Terms:

name
status

Valid Operators:

==

Query separator:

Valid Terms:

name
status

Valid Operators:

==

Query separator:

Show all sub-accounts › Responses

Successful Response

AccountsResponse

Pagination · required

AccountSummaryResponse[] · required

GET/accounts

curl https://api.cakemail.dev/accounts \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "pagination": {
    "page": 1,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "lineage": "lineage",
      "status": "trial",
      "partner": true,
      "name": "name",
      "account_owner": {
        "user_id": "user_id"
      },
      "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
      },
      "created_on": 0,
      "stripe_customer_id": "stripe_customer_id",
      "expires_on": 0
    }
  ]
}

json

application/json

Create a sub-account

POST

https://api.cakemail.dev

/accounts

Create a new sub-account under the authenticated partner or organization account.

Required scope(s): sub_accounts:write

Create a sub-account › query Parameters

partner_account_id

integer

skip_verification

boolean

Default: false

Create a sub-account › Request Body

CreateAccount

name

string · minLength: 1 · required

Account display name

object

Mailing address of the account

object

User to set as account owner

fax

string · minLength: 1

phone

string · minLength: 1

website

string · uri · minLength: 1 · maxLength: 2083

Account website URL

object

Account usage limits and feature flags

Default: {}

object

Custom domain configuration

Default: {}

trial

boolean

Whether this is a trial account

Default: false

partner

boolean

Whether this is a partner account

Default: false

Create a sub-account › Responses

Successful Response

CreateAccountResponse

id

string · required

object

string

Default: account

email

string · email

AccountFullResponse

metadata

string

created

boolean

Default: true

object[]

Default: []

POST/accounts

curl https://api.cakemail.dev/accounts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "address": {
    "address1": "address1",
    "address2": "address2",
    "city": "city",
    "country": "country",
    "province": "province",
    "postal_code": "postal_code"
  },
  "account_owner": {
    "first_name": "first_name",
    "last_name": "last_name",
    "title": "title",
    "office_phone": "office_phone",
    "mobile_phone": "mobile_phone",
    "language": "da",
    "timezone": "timezone",
    "password": "password",
    "email": "test@example.com",
    "password_strength_requirement": "VERY_WEAK"
  },
  "fax": "fax",
  "phone": "phone",
  "website": "https://www.example.com/path/to/resource",
  "usage_limits": {},
  "domains": {},
  "trial": false,
  "partner": false
}'

Example Request Body

{
  "name": "name",
  "address": {
    "address1": "address1",
    "address2": "address2",
    "city": "city",
    "country": "country",
    "province": "province",
    "postal_code": "postal_code"
  },
  "account_owner": {
    "first_name": "first_name",
    "last_name": "last_name",
    "title": "title",
    "office_phone": "office_phone",
    "mobile_phone": "mobile_phone",
    "language": "da",
    "timezone": "timezone",
    "password": "password",
    "email": "test@example.com",
    "password_strength_requirement": "VERY_WEAK"
  },
  "fax": "fax",
  "phone": "phone",
  "website": "https://www.example.com/path/to/resource",
  "usage_limits": {},
  "domains": {},
  "trial": false,
  "partner": false
}

json

Example Responses

{
  "id": "id",
  "object": "account",
  "email": "test@example.com",
  "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": {}
  },
  "metadata": "metadata",
  "created": true,
  "warnings": []
}

json

application/json

Show sub-account details

GET

https://api.cakemail.dev

/accounts/{account_id}

Retrieve the full details of a sub-account.

Required scope(s): sub_accounts:read

Show sub-account details › path Parameters

account_id

string · minLength: 1 · maxLength: 20 · pattern: ^[a-zA-Z0-9]+$ · required

Show sub-account details › Responses

Successful Response

GetAccountResponse

AccountFullResponseWithUsageFlags · required

GET/accounts/{account_id}

curl https://api.cakemail.dev/accounts/:account_id \
  --header 'Authorization: Bearer <token>'

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,
      "use_transactional_emails": true,
      "attachment_types": {
        "csv": true,
        "doc": true,
        "docx": true,
        "calendar": true,
        "jpeg": true,
        "pdf": true,
        "png": true,
        "xls": true,
        "xlsx": 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 a sub-account

PATCH

https://api.cakemail.dev

/accounts/{account_id}

Update a sub-account's settings, including name, address, usage limits, and feature flags.

Required scope(s): sub_accounts:write

Update a sub-account › path Parameters

account_id

integer · required

Update a sub-account › Request Body

PatchAccount

object

Mailing address of the account

name

string

Account display name

object

User to set as account owner

fax

string

phone

string

object

Custom domain configuration

Default: {}

website

string · uri · minLength: 1 · maxLength: 2083

Account website URL

object

Account usage limits and feature flags

Default: {}

trial

boolean

Whether this is a trial account

partner

boolean

Whether this is a partner account

metadata

object

Arbitrary metadata for the account

Update a sub-account › Responses

Successful Response

PatchAccountResponse

AccountFullResponse · required

object[]

Default: []

PATCH/accounts/{account_id}

curl https://api.cakemail.dev/accounts/:account_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "address": {
    "address1": "address1",
    "address2": "address2",
    "city": "city",
    "country": "country",
    "province": "province",
    "postal_code": "postal_code"
  },
  "name": "name",
  "account_owner": {
    "user_id": 1
  },
  "fax": "fax",
  "phone": "phone",
  "domains": {},
  "website": "https://www.example.com/path/to/resource",
  "usage_limits": {},
  "trial": true,
  "partner": true,
  "metadata": {}
}'

Example Request Body

{
  "address": {
    "address1": "address1",
    "address2": "address2",
    "city": "city",
    "country": "country",
    "province": "province",
    "postal_code": "postal_code"
  },
  "name": "name",
  "account_owner": {
    "user_id": 1
  },
  "fax": "fax",
  "phone": "phone",
  "domains": {},
  "website": "https://www.example.com/path/to/resource",
  "usage_limits": {},
  "trial": true,
  "partner": true,
  "metadata": {}
}

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

Delete a sub-account

DELETE

https://api.cakemail.dev

/accounts/{account_id}

Delete a sub-account. This action is permanent.

Required scope(s): sub_accounts:admin

Delete a sub-account › path Parameters

account_id

string · minLength: 1 · maxLength: 20 · pattern: ^[a-zA-Z0-9]+$ · required

Delete a sub-account › Responses

Successful Response

DeleteAccountResponse

id

string · required

object

string

Default: account

deleted

boolean

Default: true

Suspend a sub-account

POST

https://api.cakemail.dev

/accounts/{account_id}/suspend

Suspend a sub-account, preventing its users from logging in or sending emails.

Required scope(s): sub_accounts:admin

Suspend a sub-account › path Parameters

account_id

integer · min: 1 · required

Suspend a sub-account › Responses

Successful Response

SuspendAccountResponse

id

string · required

AccountSummaryResponse · required

object

string

Default: account

suspended

boolean

Default: true

POST/accounts/{account_id}/suspend

curl https://api.cakemail.dev/accounts/:account_id/suspend \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "object": "account",
  "suspended": true,
  "data": {
    "id": "id",
    "lineage": "lineage",
    "status": "trial",
    "partner": true,
    "name": "name",
    "account_owner": {
      "user_id": "user_id"
    },
    "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
    },
    "created_on": 0,
    "stripe_customer_id": "stripe_customer_id",
    "expires_on": 0
  }
}

json

application/json

Unsuspend a sub-account

POST

https://api.cakemail.dev

/accounts/{account_id}/unsuspend

Restore a suspended sub-account, allowing its users to log in and send emails again.

Required scope(s): sub_accounts:admin

Unsuspend a sub-account › path Parameters

account_id

integer · min: 1 · required

Unsuspend a sub-account › Responses

Successful Response

UnsuspendAccountResponse

id

string · required

AccountSummaryResponse · required

object

string

Default: account

unsuspended

boolean

Default: true

POST/accounts/{account_id}/unsuspend

curl https://api.cakemail.dev/accounts/:account_id/unsuspend \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "object": "account",
  "unsuspended": true,
  "data": {
    "id": "id",
    "lineage": "lineage",
    "status": "trial",
    "partner": true,
    "name": "name",
    "account_owner": {
      "user_id": "user_id"
    },
    "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
    },
    "created_on": 0,
    "stripe_customer_id": "stripe_customer_id",
    "expires_on": 0
  }
}

json

application/json

Confirm sub-account creation

POST

https://api.cakemail.dev

/accounts/{account_id}/confirm

Confirm a pending sub-account using the confirmation token from the verification email.

Confirm sub-account creation › path Parameters

account_id

string · minLength: 1 · maxLength: 20 · pattern: ^[a-zA-Z0-9]+$ · required

Confirm sub-account creation › Request Body

ConfirmAccount

confirmation

string · required

Confirm sub-account creation › Responses

Successful Response

ConfirmAccountResponse

id

string · required

object

string

Default: account

email

string · email

AccountFullResponse

metadata

string

confirmed

boolean

Default: true

POST/accounts/{account_id}/confirm

curl https://api.cakemail.dev/accounts/:account_id/confirm \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "confirmation": "confirmation"
}'

Example Request Body

{
  "confirmation": "confirmation"
}

json

Example Responses

{
  "id": "id",
  "object": "account",
  "email": "test@example.com",
  "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": {}
  },
  "metadata": "metadata",
  "confirmed": true
}

json

application/json

Resend the account verification email

POST

https://api.cakemail.dev

/accounts/resend-verification-email

Resend the verification email for a pending sub-account.

Resend the account verification email › Request Body

ResendVerificationEmail

email

string · email · required

Email address to resend the verification to

Resend the account verification email › Responses

Successful Response

ResendAccountVerificationEmailResponse

object

string

Default: account

verification_resent

boolean

Default: true

Convert an account to an Organization

POST

https://api.cakemail.dev

/accounts/{account_id}/convert-to-organization

Convert a sub-account into an organization, allowing it to manage its own sub-accounts.

Required scope(s): sub_accounts:admin

Convert an account to an Organization › path Parameters

account_id

integer · required

Convert an account to an Organization › Request Body

migrate_owner

boolean

Migrate the account owner from the original account to the Organization.

Default: true

Convert an account to an Organization › Responses

Successful Response

AccountResponse

AccountFullResponse · required

POST/accounts/{account_id}/convert-to-organization

curl https://api.cakemail.dev/accounts/:account_id/convert-to-organization \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "migrate_owner": true
}'

Example Request Body

{
  "migrate_owner": true
}

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": {}
  }
}

json

application/json

Logo Action