Skip to main content
POST
/
api
/
v1
/
send
{
  "to": ["user1@example.com", "user2@example.com"],
  "subject": "Hello World",
  "from_email": "noreply@yourdomain.com",
  "body_html": "<h1>Say Hello!</h1>",
  "body_text": "Say Hello!",
  "cc": ["team_member@example.com"],
  "bcc": ["archive@example.com"],
  "template_id": "uuid-of-the-template",
  "template_data": {
    "first_name": "John",
    "invoice_amount": "49.99"
  },
  "reply_to": ["support@yourdomain.com"],
  "sender_name": "The Awesome Team",
  "attachments": [
    {
      "filename": "invoice_001.pdf",
      "file_path": "/path/to/local/invoice.pdf",
      "mime_type": "application/pdf"
    }
  ]
}

{
  "message_id": "000001234abcd...",
  "status": "sent"
}
Under the hood, all our SDKs interface directly with the SendSculpt Mailer through this endpoint. While the SDKs do the heavy lifting, it’s beneficial to understand how the API accepts data.

​
Authentication

SendSculpt uses an API Key for authentication. Pass your key in the custom header x-sendsculpt-key.
​
x-sendsculpt-key
string
required
Your SendSculpt API Key for authentication.

​
Request Body

​
to
array of strings
required
List of primary recipient email addresses.
​
subject
string
required
The subject line of the email.
​
from_email
string
required
The sender email address. Its domain must be registered and fully verified (SPF, DKIM) under your SendSculpt organization account.
​
body_html
string
The HTML body of the email. Cannot be used alongside template_id.
​
body_text
string
The plain text fallback body of the email. Cannot be used alongside template_id.
​
cc
array of strings
List of secondary recipient email addresses.
​
bcc
array of strings
List of blind carbon copy recipient email addresses.
​
template_id
string
UUID of the template to utilize. If provided, body_html and body_text are ignored.
​
template_data
object
Context variables (key-value pairs) injected into the email template. Requires a template_id to be present.
​
reply_to
array of strings
Email address(es) that recipients should direct replies to.
​
sender_name
string
The friendly display name of the sender.
​
attachments
array of objects

​
Response

​
message_id
string
A unique identifier representing the queued email request.
​
status
string
The initial status of the email, typically "sent" upon successful queueing.
{
  "to": ["user1@example.com", "user2@example.com"],
  "subject": "Hello World",
  "from_email": "noreply@yourdomain.com",
  "body_html": "<h1>Say Hello!</h1>",
  "body_text": "Say Hello!",
  "cc": ["team_member@example.com"],
  "bcc": ["archive@example.com"],
  "template_id": "uuid-of-the-template",
  "template_data": {
    "first_name": "John",
    "invoice_amount": "49.99"
  },
  "reply_to": ["support@yourdomain.com"],
  "sender_name": "The Awesome Team",
  "attachments": [
    {
      "filename": "invoice_001.pdf",
      "file_path": "/path/to/local/invoice.pdf",
      "mime_type": "application/pdf"
    }
  ]
}

{
  "message_id": "000001234abcd...",
  "status": "sent"
}