Send email

POST

https:/omerlo.com/api/media/v1/mail/send

Send a email using Omerlo CMS. You can send an email using two distinct flows: by platform or by media.
This endpoint requires an application token. This mean you *MUST use the token generated via your client's id and secret. If you use the reader's token you'll have an unauthorized response.

You are in charge on providing a valid html that will be send to the to. We recommand using mjml and test it well (especially for Microsoft's products on Windows).

For the platform's flow, the header x-omerlo-media-id is not required.

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Query Params

Body Params text/html

Examples

Responses

🟢204No Content

application/json

Body

🟠400Bad Request

🟠400Missing x-omerlo header

🟠401Authorization

🟠403Forbidden

🟠406Not Acceptable

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https/omerlo.com/api/media/v1/mail/send?context=platform&to=example@acme.com&subject=Hello' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: text/html' \
--data-raw '<H1>Hello world</H1>'

Response Example

204 - Success

{
  "error": "invalid_token",
  "error_description": "Token missing scope: application"
}

List providers

Menu by key