Skip to main content

​
Authentication

All SendSculpt API endpoints require authentication using a secret API Key. You must include this key in the header of every HTTP request you make to the SendSculpt servers. When you use one of the official SDKs, the client simply handles this for you upon initialization.

​
Obtaining an API Key

You can create and manage your API keys directly from your Dashboard:

Manage API Keys

Generate a new API key in the SendSculpt Dashboard Settings.
 Keep your API keys confidential. Do not share them in publicly accessible areas such GitHub, client-side code, or public forums.

​
Passing the API Key (Raw HTTP)

If you are not using one of the official SDKs, you authenticate to the SendSculpt Mailer API by providing your API key in the x-sendsculpt-key header. 
curl --request POST \
  --url https://api.sendsculpt.com/api/v1/send \
  --header 'Content-Type: application/json' \
  --header 'x-sendsculpt-key: your_secret_api_key_here' \
  --data '...payload...'

​
Environments

SendSculpt provides two distinct environments for interacting with the Mailer API: Live and Sandbox.

​
Live Environment

The Live environment triggers actual email dispatches to the intended recipients and impacts your billing quota.
DescriptionURL
Base URLhttps://api.sendsculpt.com/api/v1

​
Sandbox Environment

The Sandbox environment mimics the Live environment precisely, but it gracefully bypasses the final SMTP transport. The SendSculpt Mailer engine will still validate your payload structure, templates, attachments, and authentication, but no emails will actually be delivered. This is incredibly useful during local development and CI/CD pipelines to ensure your integration is strictly functional without spamming real inboxes.
DescriptionURL
Sandbox Base URLhttps://sandbox.sendsculpt.com/api/v1

Sandbox Logs

View captured dispatch payloads in the Sandbox dashboard.

​
Using Sandbox with the SDKs

You can direct any SendSculpt SDK to utilize the Sandbox environment instead of the default Live environment by passing the Sandbox Base URL into the client constructor during initialization. 
import { SendSculptClient } from "sendsculpt-sdk";

const client = new SendSculptClient(
  "your_api_key",
  "https://sandbox.sendsculpt.com/api/v1"
);