Cakemail Logo
Cakemail API

​User (1.18.25)

Endpoint:https://api.cakemail.dev

​Show my user details

GET
https://api.cakemail.dev
/users/self

​Show my user details › Responses

    • dataobject · required

​Forgot my password

POST
https://api.cakemail.dev
/users/forgot-my-password

​Forgot my password › query Parameters

  • account_idinteger · min: 1
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
    Default: en_US

​Forgot my password › Request Body

  • emailstring · email · required

​Forgot my password › Responses

    • emailstring · required
    • objectstring
      Default: user
    • reset_link_sentboolean
      Default: true

​Reset my password

POST
https://api.cakemail.dev
/users/self/reset-password

​Reset my password › Responses

    • emailstring · required
    • objectstring
      Default: user
    • reset_link_sentboolean
      Default: true

​Reset a user password

POST
https://api.cakemail.dev
/users/{user_id}/reset-password

​Reset a user password › path Parameters

  • user_idinteger · required

​Reset a user password › query Parameters

  • account_idinteger

​Reset a user password › Request Body

  • invalidate_current_passwordboolean

​Reset a user password › Responses

    • emailstring · required
    • objectstring
      Default: user
    • reset_link_sentboolean
      Default: true

​Reset password confirmation

POST
https://api.cakemail.dev
/users/reset-password-confirm

​Reset password confirmation › Request Body

  • tokenstring · required
  • passwordstring · required

​Reset password confirmation › Responses

    • objectstring
      Default: user
    • password_resetboolean
      Default: true

​Show all users in my account

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

​Show all users in my account › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • filterstring

​Show all users in my account › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a user

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

​Create a user › query Parameters

  • account_idinteger · min: 1
  • skip_verificationboolean

​Create a user › Request Body

  • first_namestring · required
  • last_namestring · required
  • emailstring · email · required
  • titlestring
  • office_phonestring
  • mobile_phonestring · pattern: [0-9]+
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • timezonestring
  • passwordstring · minLength: 8
  • password_strength_requirementstring · enum
    Enum values:
    VERY_WEAK
    WEAK
    MODERATE
    STRONG
    VERY_STRONG
    Default: VERY_WEAK

​Create a user › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: user
    • createdboolean
      Default: true

​Show a user details

GET
https://api.cakemail.dev
/users/{user_id}

​Show a user details › path Parameters

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

​Show a user details › query Parameters

  • account_idinteger · min: 1

​Show a user details › Responses

    • dataobject · required

​Delete a user

DELETE
https://api.cakemail.dev
/users/{user_id}

​Delete a user › path Parameters

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

​Delete a user › query Parameters

  • account_idinteger · min: 1

​Delete a user › Responses

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

​Update a user

PATCH
https://api.cakemail.dev
/users/{user_id}

​Update a user › path Parameters

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

​Update a user › query Parameters

  • account_idinteger · min: 1

​Update a user › Request Body

  • first_namestring
  • last_namestring
  • titlestring
  • office_phonestring
  • mobile_phonestring · pattern: [0-9]+
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • timezonestring
  • passwordobject

​Update a user › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: user
    • patchedboolean
      Default: true

​Suspend a user

POST
https://api.cakemail.dev
/users/{user_id}/suspend

​Suspend a user › path Parameters

  • user_idinteger · required

​Suspend a user › query Parameters

  • account_idinteger · min: 1

​Suspend a user › Responses

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

​Unsuspend a user

POST
https://api.cakemail.dev
/users/{user_id}/unsuspend

​Unsuspend a user › path Parameters

  • user_idinteger · required

​Unsuspend a user › query Parameters

  • account_idinteger · min: 1

​Unsuspend a user › Responses

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

​Confirm a user

POST
https://api.cakemail.dev
/users/{user_id}/confirm

​Confirm a user › path Parameters

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

​Confirm a user › Request Body

  • confirmationstring · required
  • passwordstring · minLength: 8 · required

​Confirm a user › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: user
    • confirmedboolean
      Default: true

​Resend the user verification email

POST
https://api.cakemail.dev
/users/{user_id}/resend-verification-email

​Resend the user verification email › path Parameters

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

​Resend the user verification email › query Parameters

  • account_idinteger · min: 1

​Resend the user verification email › Responses

    • objectstring
      Default: user
    • confirmation_resentboolean
      Default: true

​List active MFA methods

GET
https://api.cakemail.dev
/users/self/mfa

​List active MFA methods › query Parameters

  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean

​List active MFA methods › Responses

    • paginationobject · required
    • dataobject[] · required

​Attach an MFA method

POST
https://api.cakemail.dev
/users/self/mfa

​Attach an MFA method › Request Body

  • typestring · enum · required
    Enum values:
    totp
  • descriptionstring

​Attach an MFA method › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: mfa
    • createdboolean
      Default: true

​Activate an MFA method

POST
https://api.cakemail.dev
/users/self/mfa/{mfa_id}/activate

​Activate an MFA method › path Parameters

  • mfa_idstring · required

​Activate an MFA method › Request Body

  • codestring · minLength: 6 · maxLength: 6 · pattern: ^[0-9]+$ · required

​Activate an MFA method › Responses

    • idstring · required
    • objectstring
      Default: mfa
    • activatedboolean
      Default: true

​Get MFA recovery codes

GET
https://api.cakemail.dev
/users/self/mfa-recovery-codes

​Get MFA recovery codes › Responses

    • datastring[] · required

​Get the MFA portal URL

GET
https://api.cakemail.dev
/users/self/mfa-portal

​Get the MFA portal URL › query Parameters

  • return_urlstring · uri · minLength: 1 · maxLength: 2083

​Get the MFA portal URL › Responses

    • urlstring · uri · minLength: 1 · maxLength: 2083 · required

​Remove an MFA method

DELETE
https://api.cakemail.dev
/users/self/mfa/{mfa_id}

​Remove an MFA method › path Parameters

  • mfa_idstring · required

​Remove an MFA method › Responses

    • idstring · required
    • objectstring
      Default: mfa
    • deletedboolean
      Default: true
TokenSub-Account