System Email

Configure system-generated emails such as double opt-in confirmations, welcome messages, and unsubscribe confirmations. System emails can be customized per language.

Show system emails configuration

GET

https://api.cakemail.dev

/brands/default/system-emails

Show system emails configuration

Required scope(s): system_emails:read

Show system emails configuration › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show system emails configuration › Responses

Successful Response

SystemEmailsResponse

SystemEmailsTemplates · required

GET/brands/default/system-emails

curl https://api.cakemail.dev/brands/default/system-emails \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "account_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "user_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "sender_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "password_reset": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "contact_double_opt_in": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ]
  }
}

json

application/json

Set system emails configuration

PUT

https://api.cakemail.dev

/brands/default/system-emails

Set system emails configuration

Required scope(s): system_emails:write

Set system emails configuration › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Set system emails configuration › Request Body

SystemEmailsTemplates

SystemEmailTemplate[]

Set system emails configuration › Responses

Successful Response

PutSystemEmailsResponse

SystemEmailsTemplates · required

object

string

Default: systememails

updated

boolean

Default: true

PUT/brands/default/system-emails

curl https://api.cakemail.dev/brands/default/system-emails \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "account_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "user_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "sender_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "password_reset": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "contact_double_opt_in": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ]
}'

Example Request Body

{
  "account_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "user_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "sender_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "password_reset": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "contact_double_opt_in": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ]
}

json

Example Responses

{
  "object": "systememails",
  "updated": true,
  "data": {
    "account_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "user_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "sender_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "password_reset": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "contact_double_opt_in": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ]
  }
}

json

application/json

Update system emails configuration

PATCH

https://api.cakemail.dev

/brands/default/system-emails

Partially update system emails configuration

Required scope(s): system_emails:write

Update system emails configuration › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Update system emails configuration › Request Body

SystemEmailsTemplates

SystemEmailTemplate[]

Update system emails configuration › Responses

Successful Response

PutSystemEmailsResponse

SystemEmailsTemplates · required

object

string

Default: systememails

updated

boolean

Default: true

PATCH/brands/default/system-emails

curl https://api.cakemail.dev/brands/default/system-emails \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "account_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "user_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "sender_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "password_reset": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "contact_double_opt_in": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ]
}'

Example Request Body

{
  "account_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "user_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "sender_confirm": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "password_reset": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ],
  "contact_double_opt_in": [
    {
      "language": "da",
      "template": {
        "id": 0
      },
      "sender": {
        "id": "id"
      }
    }
  ]
}

json

Example Responses

{
  "object": "systememails",
  "updated": true,
  "data": {
    "account_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "user_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "sender_confirm": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "password_reset": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ],
    "contact_double_opt_in": [
      {
        "language": "da",
        "template": {
          "id": 0
        },
        "sender": {
          "id": "id"
        }
      }
    ]
  }
}

json

application/json

Links Task