Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
Emails

Send Email Message

This endpoint allows you to send a single email. Query parameters are supported.

post/v2/emails

Query parameters

unsubscribeMsgstring

Defines the display text for the unsubscribe link included in the email body, allowing recipients to opt out from future communications. This text will appear as the clickable anchor in the unsubscribe URL.

Request body

messagestring

Text to send

clientIdstring

Client id associated with registry

externalIdstring

Allows you to use a custom ID for tracing your Notifications.

tostring required

Recipient that receives the message

fromstring required

Email address that delivers the message

subjectstring required

Email subject

Example request

{
  "message": "example text",
  "clientId": "48118112",
  "externalId": "123456789abcde",
  "to": "+580000000005|email@service.com",
  "from": "service@service.com",
  "subject": "email subject"
}

Response

Accepted the request to send the email

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "data": {
    "id": "203",
    "date": "2020-08-08T19:43:36.278949Z",
    "to": "test@service.com",
    "from": "from@service.com",
    "userName": "myAccount@delivery.com",
    "operator": "operatorAccount@delivery.com",
    "text": "content",
    "status": "SENT",
    "subject": "Greetings",
    "externalId": "123456789abcdef",
    "clientId": "48118112",
    "alias": "customer email alias (This field is optional)"
  }
}