Cakemail Logo
Cakemail API

​Sub-Account (1.18.25)

Endpoint:https://api.cakemail.dev

​Show all sub-accounts

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

​Show all sub-accounts › query Parameters

  • partner_account_idinteger
  • recursiveboolean
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • sortstring
  • filterstring

​Show all sub-accounts › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a sub-account

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

​Create a sub-account › query Parameters

  • partner_account_idinteger
  • skip_verificationboolean

​Create a sub-account › Request Body

  • namestring · minLength: 1 · required
  • addressobject
  • account_ownerobject
  • faxstring · minLength: 1
  • phonestring · minLength: 1
  • websitestring · uri · minLength: 1 · maxLength: 2083
  • usage_limitsobject
    Default: {}
  • domainsobject
    Default: {}
  • trialboolean
  • partnerboolean

​Create a sub-account › Responses

    • idstring · required
    • objectstring
      Default: account
    • emailstring · email
    • dataobject
    • metadatastring
    • createdboolean
      Default: true
    • warningsobject[]
      Default: []

​Show sub-account details

GET
https://api.cakemail.dev
/accounts/{account_id}

​Show sub-account details › path Parameters

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

​Show sub-account details › Responses

    • dataobject · required

​Delete a sub-account

DELETE
https://api.cakemail.dev
/accounts/{account_id}

​Delete a sub-account › path Parameters

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

​Delete a sub-account › Responses

    • idstring · required
    • objectstring
      Default: account
    • deletedboolean
      Default: true

​Update a sub-account

PATCH
https://api.cakemail.dev
/accounts/{account_id}

​Update a sub-account › path Parameters

  • account_idinteger · required

​Update a sub-account › Request Body

  • addressobject
  • namestring
  • account_ownerobject
  • faxstring
  • phonestring
  • domainsobject
    Default: {}
  • websitestring · uri · minLength: 1 · maxLength: 2083
  • usage_limitsobject
    Default: {}
  • trialboolean
  • partnerboolean
  • metadataobject

​Update a sub-account › Responses

    • dataobject · required
    • warningsobject[]
      Default: []

​Suspend a sub-account

POST
https://api.cakemail.dev
/accounts/{account_id}/suspend

​Suspend a sub-account › path Parameters

  • account_idinteger · min: 1 · required

​Suspend a sub-account › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: account
    • suspendedboolean
      Default: true

​Unsuspend a sub-account

POST
https://api.cakemail.dev
/accounts/{account_id}/unsuspend

​Unsuspend a sub-account › path Parameters

  • account_idinteger · min: 1 · required

​Unsuspend a sub-account › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: account
    • unsuspendedboolean
      Default: true

​Confirm sub-account creation

POST
https://api.cakemail.dev
/accounts/{account_id}/confirm

​Confirm sub-account creation › path Parameters

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

​Confirm sub-account creation › Request Body

  • confirmationstring · required

​Confirm sub-account creation › Responses

    • idstring · required
    • objectstring
      Default: account
    • emailstring · email
    • dataobject
    • metadatastring
    • confirmedboolean
      Default: true

​Resend the account verification email

POST
https://api.cakemail.dev
/accounts/resend-verification-email

​Resend the account verification email › Request Body

  • emailstring · email · required

​Resend the account verification email › Responses

    • objectstring
      Default: account
    • verification_resentboolean
      Default: true

​Convert an account to an Organization

POST
https://api.cakemail.dev
/accounts/{account_id}/convert-to-organization

​Convert an account to an Organization › path Parameters

  • account_idinteger · required

​Convert an account to an Organization › Request Body

  • migrate_ownerboolean
    Default: true

​Convert an account to an Organization › Responses

    • dataobject · required
UserWorkflow