Send Email

{
  "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"
    }
  ]
}

{
  "status": true,
  "code": 200,
  "message": "success",
  "data": {
    "message_id": "14c8b715-e0f7-4339-b098-4fc2d81d78b1",
    "status": "queued"
  },
  "error": null
}

POST

api

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"
    }
  ]
}

{
  "status": true,
  "code": 200,
  "message": "success",
  "data": {
    "message_id": "14c8b715-e0f7-4339-b098-4fc2d81d78b1",
    "status": "queued"
  },
  "error": null
}

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.

string

required

Your SendSculpt API Key for authentication.

Request Body

array of strings

required

List of primary recipient email addresses.

string

required

The subject line of the email.

string

required

The sender email address. Its domain must be registered and fully verified (SPF, DKIM) under your SendSculpt organization account.

string

The HTML body of the email. Cannot be used alongside template_id.

string

The plain text fallback body of the email. Cannot be used alongside template_id.

array of strings

List of secondary recipient email addresses.

array of strings

List of blind carbon copy recipient email addresses.

string

UUID of the template to utilize. If provided, body_html and body_text are ignored.

object

Context variables (key-value pairs) injected into the email template. Requires a template_id to be present.

array of strings

Email address(es) that recipients should direct replies to.

string

The friendly display name of the sender.

array of objects

Show Attachment Object

string

required

The display name of the file attachment.

string

required

The file path of the attachment.

string

required

The MIME type of the file (e.g., application/pdf).

Response

string

A unique identifier representing the queued email request.

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"
    }
  ]
}

{
  "status": true,
  "code": 200,
  "message": "success",
  "data": {
    "message_id": "14c8b715-e0f7-4339-b098-4fc2d81d78b1",
    "status": "queued"
  },
  "error": null
}

Overview

SDKs

API Reference

Legal

Authentication

Request Body

Response

​Authentication

​Request Body

​Response

Authentication

Request Body

Response