Quick Start

Send your first API request in under 5 minutes.

This guide walks you through creating an account, generating an API key, and sending your first transactional email.

Step 1: Create an account

Sign up at platformxe.com/portal/register. You will receive a confirmation email to verify your address.

Step 2: Generate an API key

1. Log in to the Tenant Portal.
2. Navigate to Settings > API Keys.
3. Click Create API Key.
4. Select the scopes you need (start with messaging:send).
5. Copy the key — it is only shown once.

Step 3: Install the SDK

npm install @caldera/platformxe-sdk

Step 4: Send your first email

Using curl

curl -X POST https://api.platformxe.com/api/v1/messaging/email/send \
  -H "Content-Type: application/json" \
  -H "x-api-key: pxk_live_your_api_key_here" \
  -d '{
    "to": [{ "email": "recipient@example.com", "name": "Jane Doe" }],
    "subject": "Hello from PlatformXe",
    "html": "<h1>Welcome</h1><p>Your first transactional email.</p>"
  }'

Using the SDK

import { PlatformXe } from '@caldera/platformxe-sdk';

const px = new PlatformXe({
  apiKey: 'pxk_live_your_api_key_here',
});

const result = await px.email.send({
  to: [{ email: 'recipient@example.com', name: 'Jane Doe' }],
  subject: 'Hello from PlatformXe',
  html: '<h1>Welcome</h1><p>Your first transactional email.</p>',
});

console.log(result.data.messageId);

Step 5: Check the response

A successful response returns:

{
  "success": true,
  "data": {
    "messageId": "msg_abc123def456",
    "status": "queued"
  }
}

If something goes wrong, the response includes an error code and message:

{
  "success": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "Field 'to' is required and must be a non-empty array."
  }
}

Next steps

• Authentication — learn about API key scopes and rate limits
• SDKs — configure the TypeScript SDK
• Error Handling — understand the response envelope and error codes