POST
/
bulk-sending
curl --request POST \
  --url https://api.jsxmail.org/bulk-sending \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "subject": "<string>",
  "content": "<string>",
  "sender": "<string>",
  "contactGroupId": "<string>",
  "variables": [
    {
      "key": "<string>",
      "from": "contact",
      "fromKey": "<string>",
      "customValue": "<string>"
    }
  ]
}'
{
  "id": "<string>",
  "title": "<string>",
  "subject": "<string>",
  "content": "<string>",
  "totalContacts": 123,
  "userId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "_count": {
    "messages": 123,
    "failures": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
The data of the bulk sending campaign to create
​
title
string
required

Title of the bulk sending campaign

​
subject
string
required

Email subject line

​
content
string
required

HTML content of the email with variable placeholders (must include {{unsubscribeUrl}})

​
sender
string
required

Email address of the sender

​
contactGroupId
string
required

ID of the contact group to send to

​
variables
object[]
required

Variables for personalization

Response

201
application/json
Bulk sending created and queued for processing
​
id
string
required
​
title
string
required
​
subject
string
required
​
content
string
required
​
totalContacts
integer
required
​
userId
string
required
​
createdAt
string
required
​
_count
object