Skip to content
API Documentation

Send Template Email

POST
/v1/send/template
curl --request POST \
  --url https://api.contacta.mx/v1/send/template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "template_id": "template123", "to": [ { "name": "Jane Smith", "email": "jane@smith.com" } ], "variables": { "variable_a_var": "Variable A Value" }, "attachment": [ { "name": "document.pdf", "url": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf" } ], "attachment_buffer": [ { "name": "document.pdf", "content": "data:(mime type),base64,JVBERi0xLjQKJazc..." } ] }'

Sends an email using a predefined template stored in your account.

Retrieve available templates via GET /v1/templates.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

Request body for sending an email using a saved template.

The template must exist in your account. Retrieve available templates via GET /v1/templates.

Media typeapplication/json
object
template_id
required

Unique identifier of the template to use

string
Example
template123
to
required

List of recipients

Array<object>
object
name
required

Recipient display name

string
Example
Jane Smith
email
required

Recipient email address

string format: email
Example
jane@smith.com
variables

Dynamic variables to inject into the template content. Available from variable_a_var to variable_z_var.

Use them in your template with {{variable_a_var}} syntax.

object
variable_a_var

Use in dynamic content as {{variable_a_var}}

string
Example
Variable A Value
attachment

Files to attach via URL. The server will download and attach each file. (Max size per file: 10MB)

Array<object>
object
name
required

File name as it will appear in the attachment

string
Example
document.pdf
url
required

Publicly accessible URL of the file

string format: uri
Example
https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf
attachment_buffer

Files to attach via base64-encoded content. (Max size per file: 10MB)

Array<object>
object
name
required

File name as it will appear in the attachment

string
Example
document.pdf
content
required

Base64-encoded file content

string format: byte
Example
data:(mime type),base64,JVBERi0xLjQKJazc...

Responses

Section titled “Responses”

201

Section titled “201”

Email successfully queued

Media typeapplication/json
object
status
boolean
message
string
data

UUIDs assigned to each queued email, one per recipient

Array<string>
Example
{
  "status": true,
  "message": "Succesfully queued email",
  "data": [
    "1b9d6e34-634a-4762-8d5a-f9cb9165d432"
  ]
}

401

Section titled “401”

Unauthorized — invalid or missing API token

Media typeapplication/json
object
status
boolean
message
string
data
object
message
string
code
integer
Example
{
  "status": false,
  "message": "An http error occurred. If error persists, contact soporte@contacta.mx",
  "data": {
    "message": "Your key auth is not valid, please check with your administrator",
    "code": 401
  }
}

402

Section titled “402”

Insufficient credits to complete the send

Media typeapplication/json
object
status
boolean
message
string
data
object
message
string
code
integer
Example
{
  "status": false,
  "message": "An http error occurred. If error persists, contact soporte@contacta.mx",
  "data": {
    "message": "Not enough credits for make this send, please check and retry",
    "code": 402
  }
}

422

Section titled “422”

Unprocessable entity — validation failed on request body

Media typeapplication/json
object
status
boolean
message
string
data
object
message
string
code
integer
Example
{
  "status": false,
  "message": "An http error occurred. If error persists, contact soporte@contacta.mx",
  "data": {
    "message": "Missing required fields, please verify your request",
    "code": 422
  }
}

451

Section titled “451”

One or more recipients are blacklisted (unsubscribed)

Media typeapplication/json
object
status
boolean
message
string
data
object
message
string
code
integer
Example
{
  "status": false,
  "message": "An http error occurred. If error persists, contact soporte@contacta.mx",
  "data": {
    "message": "One or more email addresses are blacklisted for unsubscribing, please check.",
    "code": 451
  }
}