Sender

Manage sender identities (name and email pairs) used as the 'From' address in campaigns and transactional emails. New senders require email confirmation before use.

Show all senders

GET

https://api.cakemail.dev

/brands/default/senders

List all sender identities configured for the account, including their confirmation status.

Required scope(s): senders:read

Show all senders › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

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
email
confirmed

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

Valid terms:

name
email
confirmed

Show all senders › Responses

Successful Response

SendersResponse

object · required

Pagination metadata

SenderFullResponse[] · required

List of senders

Add a sender

POST

https://api.cakemail.dev

/brands/default/senders

Add a new sender identity. A confirmation email is sent to the specified email address. The sender cannot be used until the email is confirmed.

Required scope(s): senders:write

Add a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Add a sender › Request Body

CreateSender

name

string · minLength: 1 · required

Display name of the sender

email

string · email · required

Email address of the sender

language

string · enum

Language for sender-related communications

Enum values:

da_DK

de_DE

el_GR

en_US

Default: en_US

sharing

string · enum

Who, beyond this account, may use this sender

Enum values:

none

sub_accounts

descendants

accounts

Default: none

shared_with_account_ids

integer[] · maxItems: 100

Accounts, below this one, allowed to use this sender

Default: []

excluded_account_ids

integer[] · maxItems: 100

Accounts, below this one, denied this sender

Default: []

Add a sender › Responses

Successful Response

CreateSenderResponse

id

string · required

Unique identifier of the created sender

object · required

Created sender details

created

boolean

Whether the sender was created

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders

curl https://api.cakemail.dev/brands/default/senders \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "email": "test@example.com",
  "language": "en_US",
  "sharing": "none",
  "shared_with_account_ids": [],
  "excluded_account_ids": []
}'

Example Request Body

{
  "name": "name",
  "email": "test@example.com",
  "language": "en_US",
  "sharing": "none",
  "shared_with_account_ids": [],
  "excluded_account_ids": []
}

json

Example Responses

{
  "id": "id",
  "created": true,
  "object": "sender",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "en_US",
    "last_confirmation_sent_on": 0,
    "sharing": "none",
    "shared_with_account_ids": [
      0
    ],
    "excluded_account_ids": [
      0
    ],
    "account_id": 0
  }
}

json

application/json

Show a sender details

GET

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Retrieve the details of a sender identity, including name, email, and confirmation status.

Required scope(s): senders:read

Show a sender details › path Parameters

sender_id

string · required

Show a sender details › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show a sender details › Responses

Successful Response

SenderResponse

object · required

Sender details

Update a sender

PATCH

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Update a sender's name. Changing the email address requires creating a new sender.

Required scope(s): senders:write

Update a sender › path Parameters

sender_id

string · required

Update a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Update a sender › Request Body

UpdateSender

name

string

Display name of the sender

language

string · enum

Language for sender-related communications

Enum values:

da_DK

de_DE

el_GR

en_US

sharing

string · enum

Who, beyond this account, may use this sender

Enum values:

none

sub_accounts

descendants

accounts

shared_with_account_ids

integer[] · maxItems: 100

Accounts, below this one, allowed to use this sender

excluded_account_ids

integer[] · maxItems: 100

Accounts, below this one, denied this sender

Update a sender › Responses

Successful Response

PatchSenderResponse

id

string · required

Unique identifier of the updated sender

object · required

Updated sender details

updated

boolean

Whether the sender was updated

Default: true

object

string

Object type

Default: sender

PATCH/brands/default/senders/{sender_id}

curl https://api.cakemail.dev/brands/default/senders/:sender_id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "language": "da",
  "sharing": "none",
  "shared_with_account_ids": [
    0
  ],
  "excluded_account_ids": [
    0
  ]
}'

Example Request Body

{
  "name": "name",
  "language": "da",
  "sharing": "none",
  "shared_with_account_ids": [
    0
  ],
  "excluded_account_ids": [
    0
  ]
}

json

Example Responses

{
  "id": "id",
  "updated": true,
  "object": "sender",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "en_US",
    "last_confirmation_sent_on": 0,
    "sharing": "none",
    "shared_with_account_ids": [
      0
    ],
    "excluded_account_ids": [
      0
    ],
    "account_id": 0
  }
}

json

application/json

Delete a sender

DELETE

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Delete a sender identity. Senders currently in use by active campaigns cannot be deleted.

Required scope(s): senders:delete

Delete a sender › path Parameters

sender_id

string · required

Delete a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a sender › Responses

Successful Response

DeleteSenderResponse

id

string · required

Unique identifier of the deleted sender

deleted

boolean

Whether the sender was deleted

Default: true

object

string

Object type

Default: sender

Confirm a sender

POST

https://api.cakemail.dev

/brands/default/senders/confirm-email

Confirm a sender's email address using the token received in the confirmation email.

Required scope(s): senders:write

Confirm a sender › Request Body

ConfirmSender

confirmation_id

string · minLength: 1 · required

Confirmation token from the verification email

Confirm a sender › Responses

Successful Response

ConfirmSenderResponse

object · required

Confirmed sender details

confirmed

boolean

Whether the sender was confirmed

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders/confirm-email

curl https://api.cakemail.dev/brands/default/senders/confirm-email \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "confirmation_id": "confirmation_id"
}'

Example Request Body

{
  "confirmation_id": "confirmation_id"
}

json

Example Responses

{
  "confirmed": true,
  "object": "sender",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "en_US",
    "last_confirmation_sent_on": 0,
    "sharing": "none",
    "shared_with_account_ids": [
      0
    ],
    "excluded_account_ids": [
      0
    ],
    "account_id": 0
  }
}

json

application/json

Resend confirmation email

POST

https://api.cakemail.dev

/brands/default/senders/{sender_id}/resend-confirmation-email

Resend the confirmation email for an unconfirmed sender.

Required scope(s): senders:write

Resend confirmation email › path Parameters

sender_id

string · required

Resend confirmation email › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Resend confirmation email › Responses

Successful Response

ResendConfirmationEmailResponse

id

string · required

Unique identifier of the sender

resent

boolean

Whether the confirmation email was resent

Default: true

object

string

Object type

Default: sender

Email API DKIM