To send your email template to one or multiple recipients, you can utilize SMTP integration.

How does SMTP integration works?

1. In your dashboard, create an SMTP integration.
2. Ensure you have a template set up in your dashboard.
3. Using API you can send POST request to the designated endpoint. In the URL, specify the template ID and the integration ID. In the request body, include the sender's details and at least one recipient. Dynamic variables can also be added to your template if you need to render it with dynamic data.
4. After a successful API call, an immediate response will be received. The emails will be queued and sent in the background, effectively reducing latency in your application.

How send email with PDF attachments?

You can use SMTP integration to send emails and attach your existing PDF templates to the email.

1. Create PDF template in you dashboard.
2. When making API request, add "attachments" key with array of objects next to the recipient in your JSON body.
3. Attachment object must contain "id" key. This should be an "id" of your PDF template you've created in step 1.
4. You can also add "filename" key to specify the name of the file that will be attached to the email.
5. In case you want to render the PDF template with dynamic data, you can add "variables" key with an object of variables.

You can specify multiple attachments to single email.

Note: single email can have maximum of 20 attachments.

Using variables in the request body

When sending emails, you can set three different types of variables: global, recipient, and attachment.

Variables are optional, and you can use them only if you need to render your template with dynamic data. Here is an explanation of how to use them:

• If you set only global variables, it will be used to replace values in the email template and attachments.
• If you set recipient variables, it will be used to replace values in the email template and attachments for a specific recipient. So you can specify different values for each recipient.
• If you set attachment variables, it will be used to replace values in the specific attachment. So you can specify different values for each attachment.

{
    "from": {...},
    "to": [
        {
            ..., // Other parameters
            "variables": {
                "recipient_level": "value" // <-- Recipient level variable
            },
            "attachmens": [
                {
                    ..., // Other parameters
                    "variables": {
                        "attachment_level": "value" // <-- Attachment level variable
                    }
                }
            ]
        }
    ],
    "variables": {
        "global_level": "value" // <-- Global level variable
    }
}

Child level variables override parent level variables in the following order:

• Attachment level overrides recipient level and global level variables.
• Recipient level overrides global level variables.

Let's take a look at the example below. We have a global level variable "name" with the value "Mike". This variable will be set in the email template for recipeint [email protected].

Also, we have a recipient level variable "name" with the value "John" for [email protected]. This variable will be set in the email template and attachment for this recipient.

Finally, we have an attachment level variable "name" with the value "Tom" for [email protected]. This variable will be set only in the attachment for this recipient.

{
    "from": {...},
    "to": [
        {
            "email": "[email protected]",
            "variables": {
                "name": "John"
            },
            "attachments": [
                {
                    "id": 123
                }
            ]
        },
        {
            "email": "[email protected]",
            "attachments": [
                {
                    "id": 123,
                    "variables": {
                        "name": "Tom"
                    },
                }
            ]
        },
    ],
    "variables": {
        "name": "Mike"
    }
}

Let's take a quick look at how nested variables work. In the example below, you can see that we are using a global level variable "user", and the value is an object.

To avoid repeating the same values for each child variables, we can override only the values we need. In this case, we are overriding "name" value for the first recipient. So the "company" value will be the same as a global level variable.

{
    "from": {...},
    "to": [
        {
            "email": "[email protected]",
            "variables": {
                "user": {
                    "name": "Jhon"
                }
            }
        }
    ],
    "variables": {
        "user": {
            "name": "Mike",
            "company": "Example company"
        }
    }
}