POST
/
email
/
list
curl --request POST \
  --url https://api.indiepitcher.com/v1/email/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "subject": "IndiePitcher monthly news for {{firstName}}",
  "body": "Hi {{firstName}}, You can use **markdown** to generate the email. Plain HTML is also supported.",
  "bodyFormat": "markdown",
  "list": "important",
  "delaySeconds": null,
  "delayUntilDate": "2023-11-07T05:31:56Z",
  "trackEmailOpens": null,
  "trackEmailLinkClicks": null
}'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
subject
string
required

The subject of the email. Supports personalization.

​
body
string
required

The body of the email. Both HTML and markdown body do support personalization.

​
bodyFormat
enum<string>
required

The format of the email body. It can be either 'markdown' or 'html'.

Available options:
markdown,
html
​
list
string
required

Specify a list the contact(s) can unsubscribe from if they don't wish to receive further emails like this. The contact(s) must be subscribed to this list. Pass 'important' to provide a list the contact(s) cannot unsubscribe from.

​
delaySeconds
number | null

Delay sending of this email by the amount of seconds you provide.

​
delayUntilDate
string | null

Delay sending of this email until specified date.

​
trackEmailOpens
boolean

Whether to track email opens. Allow you to overwrite the project's global setting. Default: nil - Uses the project's global setting.

​
trackEmailLinkClicks
boolean

Whether to track when a users taps on a link in the email. Allow you to overwrite the project's global setting. Default: nil - Uses the project's global setting.

Response

200 - application/json
An empty response
​
success
boolean

Always true

Send an email to one of more registered contacts.Retrieve contacts