Transactional Email API (1.0.0)

Download OpenAPI description

Servers

Mock server

https://developers.retarus.com/_mock/tem/m4a-api/

https://mail-de.retarus.com/rest/v2/

mail

Operations

sendJobRequest

Request

Bodyapplication/jsonrequired

JobRequest - Full Example

mailobject(Mail)required

mail.fromobject(EmailAddress)required

mail.from.emailstring<= 254 charactersrequired

Example: "john.doe@example.com"

mail.mimeFromobject(EmailAddress)

mail.replyToobject(EmailAddress)

mail.inReplyTostring

Example: "<1234@example.com>"

mail.prioritystring(MailPriority)

default=NORMAL

Enum"HIGH""NORMAL""LOW"

Example: "NORMAL"

mail.xHeadersobject(EmailHeaders)<= 10 properties

Header names must start with X- max header count=10

Example: {"X-MY-ADDITIONAL-HEADER":"value1234"}

recipientsArray of objects(Recipient)[ 1 .. 100 ] itemsrequired

recipients[].mailobject(RecipientsMail)required

recipients[].mail.toArray of objects(EmailAddress)non-emptyrequired

recipients[].mail.to[].emailstring<= 254 charactersrequired

Example: "john.doe@example.com"

recipients[].mail.ccArray of objects(EmailAddress)non-empty

recipients[].mail.bccArray of objects(EmailAddress)non-empty

recipients[].mail.replyToobject(EmailAddress)

recipients[].mail.inReplyTostring

Example: "<1234@example.com>"

recipients[].mail.prioritystring(MailPriority)

default=NORMAL

Enum"HIGH""NORMAL""LOW"

Example: "NORMAL"

recipients[].mail.listUnsubscribestring

recipients[].mail.listHelpstring

recipients[].mail.xHeadersobject(EmailHeaders)<= 10 properties

Header names must start with X- max header count=10

Example: {"X-MY-ADDITIONAL-HEADER":"value1234"}

recipients[].referencestring<= 50 characters

Example: "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c"

recipients[].featuresobject(RecipientFeatures)

subjectobject(Subject)required

subject.contentstring<= 500 characters

Email subject. Max length 500 characters.

subject.templatestring

Template for email subject.

Example: "Subject-Standard-Text ${name}"

subject.contentEncodingstring

default=plain

Enum"plain""base64""quoted-printable"

Example: "plain"

subject.contentTransferEncodingstring

Value"base64"

Example: "base64"

subject.charsetstring

default=UTF-8

Example: "UTF-8"

bodyobject(Body)

alternativeobject(Alternative)

attachmentsArray of objects(Attachment)[ 1 .. 20 ] items

jobobject(Job)

notificationobject(Notification)

curl -i -X POST \
  -u <username>:<password> \
  https://developers.retarus.com/_mock/tem/m4a-api/jobs \
  -H 'Content-Type: application/json' \
  -d '{
    "subject": {
      "content": "minimal subject"
    },
    "recipients": [
      {
        "mail": {
          "to": [
            {
              "email": "test-01@null.dev.retloc"
            }
          ]
        }
      }
    ],
    "mail": {
      "from": {
        "email": "test@bot.com"
      }
    }
  }'

Responses

Accepted

Bodyapplication/json

metaobject(ResponseMeta)required

meta.receivedTsstring(date-time)

meta.campaignIdstring

meta.costCenterstring

meta.referenceJobstring

meta.jobIdstringrequired

meta.stateobject(ResponseState)required

meta.state.typestring

meta.state.subTypestring

meta.state.phasestring

meta.state.descriptionstring

meta.accountIdstring

contentobject(ResponseContent)

Response

application/json

{
  "meta": {
    "jobId": "22579950-b1cb-4ad8-be2b-715d63a06fcd",
    "state": { … }
  },
  "content": {
    "recipients": [ … ]
  }
}