POST
/
v1
/
send
Send email
curl --request POST \
  --url https://api.useplunk.com/v1/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "to": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "subscribed": true,
  "name": "<string>",
  "from": "<string>",
  "reply": "<string>",
  "headers": {},
  "attachments": {}
}'
{
  "success": true,
  "emails": [
    {
      "contact": {
        "id": "80d74d13-16eb-48c5-bc2b-aae6fd5865cc",
        "email": "hello@useplunk.com"
      },
      "email": "ebd44b76-9e1d-4826-96a1-9a240c42a939"
    },
    {
      "contact": {
        "id": "8f33fe24a-1ce7-4498-8769-f80d67b4e59d",
        "email":  "billing@useplunk.com"
      },
      "email": "bd2d0ece-7a4e-48b8-a8be-be5af077adc1"
    }
  ],
  "timestamp": "1970-01-01T00:00:00.000Z"
}

Body

to
string
required
A single email address or an array of email addresses.
subject
string
required
The subject of the email.
body
string
required
The body of the email.
subscribed
boolean
default:"false"
Should the contact be subscribed
name
string
Override the name of the sender. Defaults to the project name.
from
string
Override the email of the sender. Defaults to your verified email.
reply
string
Override the reply-to address. Defaults to the from address or your verified email if the from address is not set.
headers
object
Additional headers to include in the email.
attachments
object
Up to 5 file attachments

Headers

Content-Type
string
required
application/json

Response

success
boolean
Indicates whether the call was successful.
emails
Email Object
timestamp
datetime
The timestamp of the event.
{
  "success": true,
  "emails": [
    {
      "contact": {
        "id": "80d74d13-16eb-48c5-bc2b-aae6fd5865cc",
        "email": "hello@useplunk.com"
      },
      "email": "ebd44b76-9e1d-4826-96a1-9a240c42a939"
    },
    {
      "contact": {
        "id": "8f33fe24a-1ce7-4498-8769-f80d67b4e59d",
        "email":  "billing@useplunk.com"
      },
      "email": "bd2d0ece-7a4e-48b8-a8be-be5af077adc1"
    }
  ],
  "timestamp": "1970-01-01T00:00:00.000Z"
}