[go: up one dir, main page]
Skip to main content
POST
/
v1
/
transactional
Send transactional email
curl --request POST \
  --url https://app.loops.so/api/v1/transactional \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "transactionalId": "<string>",
  "addToAudience": true,
  "dataVariables": {},
  "attachments": [
    {
      "filename": "<string>",
      "contentType": "<string>",
      "data": "<string>"
    }
  ]
}'
{
  "success": true
}

​
Request

​
Body

​
email
string
required
The email address of the recipient.
​
transactionalId
string
required
The ID of the transactional email to send.
​
addToAudience
boolean
default:false
If true, a contact will be created in your audience using the email value (if a matching contact doesn’t already exist).
​
dataVariables
object
An object containing data as defined by the data variables added to the transactional email template. Values can be of type string or number. If you have added optional data variables to your email, you can exclude them from the dataVariables object or set the value to "".
​
attachments
object[]
Please email us to enable attachments on your account before using them with the API.
An array containing file objects sent along with an email message.
To set dynamic Subject, From, Reply to, CC, BCC email header fields, add data variables to those fields in the editor, then include data for each variable in the API request. Read our transactional email guide for more details.

​
Headers

​
Idempotency-Key
string
Optionally send an idempotency key to avoid duplicate requests. The value should be a string of up to 100 characters and should be unique for each request. We recommend using V4 UUIDs or some other method with enough guaranteed entropy to avoid collisions during a 24 hour window. The endpoint will return a 409 Conflict response if the idempotency key has been used in the previous 24 hours.

​
Response

​
Success

​
success
boolean
required

​
Error

If the transactional email is not found, a 404 Not Found will be returned. If you send an idempotency key which has already been used in the previous 24 hours, a 409 Conflict response will be returned. All other errors will be 400 Bad Request.
Deprecated fields will be removed in the future so avoid using them in your code.
​
success
boolean
required
​
message
string
required
​
path
string
deprecated
​
error
object
deprecated
​
transactionalId
string
deprecated
{
  "success": true
}
⌘I