POST
/
api
/
v1
/
campaign
/
email
/
send
curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/email/send' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": [
        "sample@gmail.com"
    ],
    "subject": "API test 1",
    "from": "test@domain.com",
    "fromName": "sahil",
    "bodyHtml": "<h1>Test 1</h1>",
    "trackClicks": true,
    "trackOpens": true,
    "replyToEmail": "test2@domain2.com",
    "attachments": ["63a98c9c2b6df936ac930c17"],
    "replyToName": "sam",
    "bodyText": "Just Text Email",
    "reportUrl": "https://webhook.site/0a276bc5-f0e4-4235-9006-b58b7d224ad5"
}'

{
  "status": true,
  "message": "Email sent successfully!"
}

​
Body

​
to
array
required

This is to contain email ids where you need to send emails. you can add multiple email ids where you need to send emails. Max 10 emails at one api.

​
subject
string
required

This contains email subject

​
from
string
required

This is a from email id. you can assigned only verified email id. you can verify from email id from zixflow dashboard by below-specified section. dashboard - campaign -> settings -> email -> domain

​
fromName
string
required

Display name for from email address

​
bodyHtml
string
required

This field used to send html content in email either bodyHtml or bodyText is required

​
bodyText
string
required

This field used to send normal text content in email either bodyHtml or bodyText is required

​
trackClicks
boolean

Should the click be tracked? If no value has been provided, Account’s default setting will be used.

​
trackOpens
boolean

Should the opens be tracked? If no value has been provided, Account’s default setting will be used

​
replyToEmail
string

Email address to reply to

​
replyToName
string

Name to use when replying to the email.

​
attachments
array

An array of ID’s of attachments. Note: you can get attachment id from uploading attachment by upload attachment API

​
reportURL
string

(Optional) Specify the URL where the user’s report and deliveries should be delivered.

​
Response

​
status
boolean

Indicates whether the call was successful. true if successful, false if not.

​
message
string

success or error response message

curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/email/send' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": [
        "sample@gmail.com"
    ],
    "subject": "API test 1",
    "from": "test@domain.com",
    "fromName": "sahil",
    "bodyHtml": "<h1>Test 1</h1>",
    "trackClicks": true,
    "trackOpens": true,
    "replyToEmail": "test2@domain2.com",
    "attachments": ["63a98c9c2b6df936ac930c17"],
    "replyToName": "sam",
    "bodyText": "Just Text Email",
    "reportUrl": "https://webhook.site/0a276bc5-f0e4-4235-9006-b58b7d224ad5"
}'

{
  "status": true,
  "message": "Email sent successfully!"
}
POST
/
api
/
v1
/
campaign
/
email
/
send
curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/email/send' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": [
        "sample@gmail.com"
    ],
    "subject": "API test 1",
    "from": "test@domain.com",
    "fromName": "sahil",
    "bodyHtml": "<h1>Test 1</h1>",
    "trackClicks": true,
    "trackOpens": true,
    "replyToEmail": "test2@domain2.com",
    "attachments": ["63a98c9c2b6df936ac930c17"],
    "replyToName": "sam",
    "bodyText": "Just Text Email",
    "reportUrl": "https://webhook.site/0a276bc5-f0e4-4235-9006-b58b7d224ad5"
}'

{
  "status": true,
  "message": "Email sent successfully!"
}

​
Body

​
to
array
required

This is to contain email ids where you need to send emails. you can add multiple email ids where you need to send emails. Max 10 emails at one api.

​
subject
string
required

This contains email subject

​
from
string
required

This is a from email id. you can assigned only verified email id. you can verify from email id from zixflow dashboard by below-specified section. dashboard - campaign -> settings -> email -> domain

​
fromName
string
required

Display name for from email address

​
bodyHtml
string
required

This field used to send html content in email either bodyHtml or bodyText is required

​
bodyText
string
required

This field used to send normal text content in email either bodyHtml or bodyText is required

​
trackClicks
boolean

Should the click be tracked? If no value has been provided, Account’s default setting will be used.

​
trackOpens
boolean

Should the opens be tracked? If no value has been provided, Account’s default setting will be used

​
replyToEmail
string

Email address to reply to

​
replyToName
string

Name to use when replying to the email.

​
attachments
array

An array of ID’s of attachments. Note: you can get attachment id from uploading attachment by upload attachment API

​
reportURL
string

(Optional) Specify the URL where the user’s report and deliveries should be delivered.

​
Response

​
status
boolean

Indicates whether the call was successful. true if successful, false if not.

​
message
string

success or error response message

curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/email/send' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": [
        "sample@gmail.com"
    ],
    "subject": "API test 1",
    "from": "test@domain.com",
    "fromName": "sahil",
    "bodyHtml": "<h1>Test 1</h1>",
    "trackClicks": true,
    "trackOpens": true,
    "replyToEmail": "test2@domain2.com",
    "attachments": ["63a98c9c2b6df936ac930c17"],
    "replyToName": "sam",
    "bodyText": "Just Text Email",
    "reportUrl": "https://webhook.site/0a276bc5-f0e4-4235-9006-b58b7d224ad5"
}'

{
  "status": true,
  "message": "Email sent successfully!"
}