api-docs v5.116.0

API Docs

Table of contents

Mailer

Mailer - Post

Back to top

Create mailer

POST /mailer

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
to string

email address
from string optional

email address
replyTo string optional

email address
templateId string optional
substitutions object optional
subject string optional
text string optional
html string optional
inquiry boolean optional

$inquiry - operators
loginAttempts boolean optional

$loginAttempts - operators

Examples

Example usage:

curl "https://yourdomain.com/mailer" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "to": "test@test.com",
    "subject": "some subject"
  }'

Parameters examples

json - Request-Example

{
  "to": "test@test.com",
  "subject": "some subject"
}

Success response

Success response - Success 200

Name Type Description
to string

email address
from string optional

email address
replyTo string optional

email address
templateId string optional
substitutions object optional
subject string optional
text string optional
html string optional

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "to": "test@test.com",
  "subject": "some subject"
}

results matching ""

    No results matching ""