Comms API ReferenceEmails

Send Emails

This operation creates and sends out emails to the specified recipients.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

OR
AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

This endpoint expects an object.
fromobjectRequired

The sending identity to associate with the Email.

tolist of objectsRequired

A list of recipients to send the email(s) to.

contentobjectRequired
The content of the Email. *** * Use the [Liquid](https://shopify.github.io/liquid/) templating language for personalization in any text-based field. * When using a templated content, use the `variables` field on each recipient to specify the values to substitute. * For each variable you specify in your template, you should have a matching key in each recipient's `variables` object. * When targeting `Profile` recipients, you may specify `variables` with values that reference stored traits, on the `Profile` -- for example: `${Twilio.Profile.dateLastPurchase}` `${Twilio.Profile.firstName}` or `${Twilio.Profile.myCustomField}`.
tagsmap from strings to stringsOptional
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 256 characters. There can be a maximum of 10 key-value pairs. This field can be templated with [Liquid](https://shopify.github.io/liquid/). Specify `variables` with each recipient for personalization.
scheduleobjectOptional

A schedule defines when a communication will be sent to a recipient.

ipPoolNamestringOptional2-64 characters
The name of the IP Pool to use for sending Emails. If not specified, all dedicated IPs associated with your account will be considered for sending. IP pools are only available to accounts with dedicated IPs. This field can be templated with [Liquid](https://shopify.github.io/liquid/). Specify `variables` with each recipient for personalization.

Response headers

Locationstring

The location (uri) of the Operation resource. Issue a GET request to this URI to retrieve the status of the Operation.

Response

The request was accepted and an Operation was created to track its progress. The response body contains the ID and link to the Operation resource.
operationIdstringformat: "^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"
The Operation ID is an identifier that can be used to correlate all of the resources created in a request. Issue a GET request to the resource list location, using the Operation ID as a query parameter to retrieve the resources that correlate with the Operation.
operationLocationstringformat: "uri"

The location (uri) of the Operation resource identified by operationId.

Errors

400
Bad Request Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error