Sign in

v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
EMAILS

Search schedule emails

Allows searching of scheduled emails

post/email/scheduled/search

Request body

schedule_idstring

The schedule_id returned from the /email/send endpoint

search_subjectstring

The subject of the email you want to search for

search_recipientstring

The recipient of the email you want to search for

search_senderstring

The sender of the email you want to search for

limitinteger

If passed will limit the search results

pageinteger

If passed will return the results of the specific page

Example request

{
  "schedule_id": "8fb29ea3-286d-493e-83c5-401f76859bb1",
  "search": "recipient@example.com",
  "limit": 100,
  "page": 2
}

Response

Scheduled email results

schedule_idstring

A unique identifier for the scheduled_email

schedulestring

A timestamp indicating when the email was scheduled. A total of 50,000 emails can be queued at any one time.

senderstring

The sender of the scheduled email

subjectstring

The subject of the email

recipientsstring

The recipients the email is scheduled to send to

client_ipstring

The IP address that scheduled the email.