SenderWiz API
HomepagePricingContact UsLoginSignup
  • Introduction
  • API URL and Key
  • Customer
    • Contact List
      • Get All Lists
      • Get One List
      • Create a List
      • Update a List
      • Copy a List
      • Delete a List
    • Fields
      • Get All List Fields
      • Get One List Field
      • Create a List Field
      • Update a List Field
      • Delete a List Field
      • Get All List Field Types
    • Segments
      • Get All List Segments
      • Get One List Segment
      • Get All Subscribers
      • Create a List Segment
      • Update a List Segment
      • Delete a List Segment
      • Get All List Segment Condition Operators
    • Subscribers
      • Get All Subscribers
      • Get One Subscriber
      • Search Subscriber by Email
      • Search by Email in All Lists
      • Search by Custom Fields in a List
      • Search Subscribers by Status
      • Get Blacklisted Subscribers
      • Get Confirmed Subscribers
      • Get Unconfirmed Subscribers
      • Get Unsubscribed Subscribers
      • Create a Subscriber
      • Create Subscribers in Bulk
      • Update a Subscriber
      • Update a Subscriber by Email
      • Create or Update a Subscriber
      • Unsubscribe a Subscriber
      • Unsubscribe a Subscriber by Email
      • Unsubscribe Subscriber from All Lists
      • Delete One Subscriber
      • Delete Subscriber by Email
    • Campaigns
      • Get All Campaigns
      • Get One Campaign
      • Create a Campaign
      • Update a Campaign
      • Copy a Campaign
      • Pause/Unpause a Campaig
      • Mark a Campaign as SENT
      • Delete a Campaign
      • Get Stats of a Campaign
    • Reports
      • Track Subscriber Click for Campaign
      • Track Subscriber Open
      • Track Subscriber Unsubscribe
    • Bounces
      • Get All Bounces
      • Create a Campaign Bounce
    • Countries
      • Get All Countries
      • Get All Zones of a Country
    • Templates
      • Get All Templates
      • Get One Template
      • Search Templates
      • Create a Template
      • Update a Template
      • Delete a Template
    • Subaccounts
      • Get All Subaccounts
      • Create a Subaccount
      • Update a Subaccount
      • Delete a Subaccount
      • Get Subaccount Permissions
      • Update Subaccount Permissions
    • Transactional Emails
      • Get All Transactional Emails
      • Get One Transactional Email
      • Create a Transactional Email
      • Delete a Transactional Email
  • Admin
    • Customer
      • Get All Customers
      • Get One Customer
      • Create a Customer
      • Update a Customer
      • Delete a Customer
      • Get All Customer Groups
      • Get All Timezones
    • Customer Login via Token
    • Customer Task via Admin API
Powered by GitBook
On this page
  1. Customer
  2. Transactional Emails

Create a Transactional Email

Create and schedule a new transactional email, with optional attachments and plain text content.

✉️ Create a Transactional Email

Use this endpoint to send or schedule a transactional email to a recipient.


🔹 HTTP Request

POST API-URL/transactional-emails

🔐 Authorization Header

X-API-KEY: your-api-key-here

📥 POST Parameters

Parameter
Type
Required
Description

email

array

Yes

Array with email details

📌 Data Block - Required

Field
Type
Required
Description

to_name

string

Yes

Recipient name

to_email

string

Yes

Recipient email

from_name

string

Yes

Sender name

subject

string

Yes

Email subject

body

string

Yes

Email body (HTML)

send_at

datetime

Yes

UTC datetime in Y-m-d H:i:s format

📝 Optional Fields

Field
Type
Description

plain_text

string

Auto generated if missing

from_email

string

Sender email address

reply_to_name

string

Reply-to name

reply_to_email

string

Reply-to email address

attachments

array

List of attachments (type, name, data)


💻 PHP Example

// CREATE A NEW EMAIL
$rand = rand();
$response = $endpoint->create([
    'to_name'           => 'Lucas Demo',
    'to_email'          => 'lucas@demo.net',
    'from_name'         => 'Evelyn Sender',
    'from_email'        => 'evelyn@demo.net',
    'reply_to_name'     => 'Evelyn Sender',
    'reply_to_email'    => 'evelyn@demo.net',
    'subject'           => 'This is a sample email subject',
    'body'              => '<strong>Hello from SenderWiz!</strong>',
    'plain_text'        => 'Hello from SenderWiz!',
    'send_at'           => date('Y-m-d H:i:s'),
    'attachments'       => [
        [
            'type' => 'image/png',
            'name' => basename(__DIR__ . '/files/image.png'),
            'data' => base64_encode((string)file_get_contents(__DIR__ . '/files/image.png')),
        ],
        [
            'type' => 'application/pdf',
            'name' => basename(__DIR__ . '/files/document.pdf'),
            'data' => base64_encode((string)file_get_contents(__DIR__ . '/files/document.pdf')),
        ],
    ]
]);

// DISPLAY RESPONSE
echo '<hr /><pre>';
print_r($response->body);
echo '</pre>';

📦 Sample JSON Response

{
  "status": "success",
  "email_uid": "te456j4jqn1a1"
}
PreviousGet One Transactional EmailNextDelete a Transactional Email

Last updated 1 month ago