Send an email. Requires `type`, `to`, `subject`, and `html`. Optional: `fromAddress`, `fromName`, `schedule`, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.

POST

/email

curl --request POST \
  --url https://api.pingram.io/email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "example", "to": "example", "subject": "example", "html": "example", "fromName": "example", "fromAddress": "example", "previewText": "example", "replyToAddresses": [ "example" ], "ccAddresses": [ "example" ], "bccAddresses": [ "example" ], "attachments": [ { "filename": "example", "url": "example" } ], "schedule": "example" }'

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

Request Body^required

Media typeapplication/json

Request body for POST /email (send email without a template).

object

type

required

The notification type to send.

string

to

required

The email address of the recipient.

string

subject

required

The subject of the email.

string

html

required

The HTML body of the email.

string

fromName

The display name of the sender.

string

fromAddress

The email address of the sender.

string

previewText

The preview text of the email.

string

replyToAddresses

The reply-to addresses of the email.

Array<string>

ccAddresses

The CC addresses of the email.

Array<string>

bccAddresses

The BCC addresses of the email.

Array<string>

attachments

URL-based file attachments. Up to 20 MB per file.

Array<object>

object

filename

required

string

url

required

string

schedule

The ISO 8601 datetime to schedule the email.

string

Example^generated

{
  "type": "example",
  "to": "example",
  "subject": "example",
  "html": "example",
  "fromName": "example",
  "fromAddress": "example",
  "previewText": "example",
  "replyToAddresses": [
    "example"
  ],
  "ccAddresses": [
    "example"
  ],
  "bccAddresses": [
    "example"
  ],
  "attachments": [
    {
      "filename": "example",
      "url": "example"
    }
  ],
  "schedule": "example"
}

Responses

200

Successful response

Media typeapplication/json

Any of:

object

Success response for POST /email.

object

trackingId

required

string

messages

required

Array<string>

object

Error response for POST /email.

object

trackingId

required

string

error

required

Error details for email send failures.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "messages": [
    "example"
  ]
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}