Email Campaign
Upload Attachment
This API used to upload attachments in zixflow platform. Purpose of API is whenever the user wants to send an attachment in the email. user need to upload attachment in zixflow platform first. zixflow will provide id represents to attachment. and the user can send this id in send email API's attachment field to send attachment along with the email
POST
/
api
/
v1
/
campaign
/
email
/
upload
Authorization
Body
curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/email/upload' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--form 'file=@"<path-to-file>"'
{
"status": true,
"data": {
"filename": "file-welcome-screen-1672054415115.png",
"size": 7343,
"dateadded": "2022-12-26T11:33:36.2633971Z",
"expirationdate": null,
"fileid": "63a98690b0ec6c81460f4f1d",
"contenttype": "image/png",
"mediumscreenshotpath": "93b7fbda-4306-4ab7-bb80-e4375750ea76/mediumscreenshots/file-welcome-screen-1672054415115.png",
"thumbnailpath": "93b7fbda-4306-4ab7-bb80-e4375750ea76/thumbnails/file-welcome-screen-1672054415115.png"
},
"message": "Successfully uploaded file"
}
Body
file
file
requiredThe “File” field refers to an attachment file that must be included in an email campaign. The file can be in any format, and its size should not exceed 25 megabytes (MB).
Response
status
boolean
Indicates whether the call was successful. true if successful, false if not.
message
string
success or error response message
data
object
The contents of uploaded file
curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/email/upload' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--form 'file=@"<path-to-file>"'
{
"status": true,
"data": {
"filename": "file-welcome-screen-1672054415115.png",
"size": 7343,
"dateadded": "2022-12-26T11:33:36.2633971Z",
"expirationdate": null,
"fileid": "63a98690b0ec6c81460f4f1d",
"contenttype": "image/png",
"mediumscreenshotpath": "93b7fbda-4306-4ab7-bb80-e4375750ea76/mediumscreenshots/file-welcome-screen-1672054415115.png",
"thumbnailpath": "93b7fbda-4306-4ab7-bb80-e4375750ea76/thumbnails/file-welcome-screen-1672054415115.png"
},
"message": "Successfully uploaded file"
}