Email API
API methods to manage emails

createEmailMessage

post
https://cp.pushwoosh.com/json/1.3
/createEmailMessage
/createEmailMessage
Example
1
{
2
"request": {
3
"application": "APPLICATION_CODE",
4
"applications_group": "GROUP_CODE", // Can be used instead of "application".
5
"auth": "API_ACCESS_TOKEN",
6
"notifications": [{
7
"campaign": "CAMPAIGN_CODE", // To assign this email message to a particular campaign, add a campaign code here.
8
"transactionId": "6e22a9af-84e4-46e6-af16-e457a4a6e7e5", // Unique message identifier to prevent re-sending in case of network problems. Stored on the side of Pushwoosh for 1 day.
9
"send_date": "now", // YYYY-MM-DD HH:mm OR 'now'
10
"ignore_user_timezone": true, // or false
11
"email_template": "ERDWE-32GFR", // email template code. Copy the template code from the URL bar of the Email Templates editor page in Pushwoosh Control Panel.
12
"timezone": "America/New_York", // Specify to send the message according to timezone set on user's device.
13
"filter": "FILTER_NAME", // Send the email message to specific users meeting filter conditions.
14
"devices": ["email_address1", "email_address2", ..., "email_addressN"], // Specify email addresses to send targeted email messages. Not more than 1000 addresses in an array. If set, the message will only be sent to the addresses on the list. Ignored if the Application Group is used.
15
"use_auto_registration": true, // optional. Automatically register emails specified in ‘devices’ parameter
16
"users": ["userId1", "userId2", ..., "userIdN"], // If set, the email message will only be delivered to the specified user IDs (registered via /registerEmail call). Not more than 1000 user IDs in an array. If the "devices" parameter is specified, the "users" parameter will be ignored.
17
"subject": [
18
{"default": "Hello {firstname|CapitalizeFirst|user}."},
19
{"ru": "Привет, {firstname_ru|CapitalizeFirst|пользователь}."},
20
{"en": "Hello {firstname_en|CapitalizeFirst|user}."}
21
],
22
"dynamic_content_placeholders": {
23
"firstname": "John",
24
"firstname_ru": "Джон",
25
"firstname_en": "John"
26
}, // optional, placeholders for dynamic content instead of device tag values.
27
"conditions": [TAG_CONDITION1, TAG_CONDITION2, ..., TAG_CONDITIONN], // See remark below.
28
"from": {"name": "alice", "email": "[email protected]"}, //Specify a sender name and sender email address to replace the default "From name" and "From email" set up in application properties. Please note that "from_email" value should be previously verified for your account.
29
"reply-to": "[email protected]" // Specify an email address to replace the default "Reply to" set up in application properties. Please note that "reply-to" value should be previously verified for your account.
30
}]
31
}
32
}
Copied!

Tag conditions

Each tag condition is an array like [tagName, operator, operand] where
  • tagName: name of a tag
  • operator: "EQ" | "IN" | "NOTEQ" | "NOTIN" | "LTE" | "GTE" | "BETWEEN"
  • operand: string | integer | array | date

Operand description

  • EQ: tag value is equal to operand;
  • IN: tag value intersects with operand (operand must always be an array);
  • NOTEQ: tag value is not equal to an operand;
  • NOTIN: tag value does not intersect with operand (operand must always be an array);
  • GTE: tag value is greater than or equal to operand;
  • LTE: tag value is less than or equal to operand;
  • BETWEEN: tag value is greater than or equal to min operand value but less than or equal to max operand value (operand must always be an array).

String tags

Valid operators: EQ, IN, NOTEQ, NOTIN Valid operands:
  • EQ, NOTEQ: operand must be a string;
  • IN, NOTIN: operand must be an array of strings like ["value 1", "value 2", "value N"];

Integer tags

Valid operators: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE Valid operands:
  • EQ, NOTEQ, GTE, LTE: operand must be an integer;
  • IN, NOTIN: operand must be an array of integers like [value 1, value 2, value N];
  • BETWEEN: operand must be an array of integers like [min_value, max_value].

Date tags

Valid operators: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE Valid operands:
  • "YYYY-MM-DD 00:00" (string)
  • unix timestamp 1234567890 (integer)
  • "N days ago" (string) for operators EQ, BETWEEN, GTE, LTE

Boolean tags

Valid operators: EQ Valid operands: 0, 1, true, false

List tags

Valid operators: IN Valid operands: operand must be an array of strings like ["value 1", "value 2", "value N"].
Remember that “filter” and “conditions” parameters should not be used together. Also, both of them will be ignored, if the "devices" parameter is used in the same request.
Country and Language tags
Language tag value is a lowercase two-letter code according to ISO-639-1 Country tag value is an UPPERCASE two-letter code according to ISO_3166-2 For example, to send push a notification to Portuguese-speaking subscribers in Brazil, you will need to specify the following condition: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

registerEmail

post
https://cp.pushwoosh.com/json/1.3
/registerEmail
/registerEmail
Example
1
{
2
"request" : {
3
"application" : "APPLICATION_CODE",
4
"email" : "[email protected]",
5
"language" : "ru", // language locale
6
"userId" : "userId", // user ID to associate with the email address
7
"tz_offset" : 3600 // timezone offset in seconds
8
}
9
}
Copied!

deleteEmail

post
https://cp.pushwoosh.com/json/1.3
/deleteEmail
/deleteEmail
Example
1
{
2
"request" : {
3
"application" : "APPLICATION_CODE",
4
"email" : "[email protected]"
5
}
6
}
Copied!

setEmailTags

post
https://cp.pushwoosh.com/json/1.3
/setEmailTags
/setEmailTags
Example
1
{
2
"request" : {
3
"auth" : "eXKjNPrq..............R0FSsLIXuZF", // API Token with "Email API" restriction
4
"email" : "[email protected]",
5
"application" : "APPLICATION_CODE",
6
"tags" : {
7
"StringTag": "string value",
8
"IntegerTag": 42,
9
"ListTag": ["string1","string2"],
10
"DateTag": "2015-10-02 22:11", // time in UTC
11
"BooleanTag": true // valid values are: true, 1, false, 0, null
12
},
13
"userId" : "userId"
14
}
15
}
Copied!
For other device types will be returned 200 OK, though tags won't be saved.
Please avoid setting more than 50 tag values in a single /setEmailTags request.

registerEmailUser

post
https://cp.pushwoosh.com/json/1.3
/registerEmailUser
/registerEmailUser
Example
1
{
2
"request" : {
3
"auth" : "API Token", // API Token with restriction "Email API"
4
"application" : "APPLICATION_CODE",
5
"email" : "[email protected]",
6
"userId" : "userId",
7
"tz_offset" : 3600
8
}
9
}
Copied!

getBouncedEmails

post
https://cp.pushwoosh.com/json/1.3
/getBouncedEmails
/getBouncedEmails
Example
1
{
2
"request": {
3
"auth": "eXKjNPrq..............5sHvPR0FSsLIXuZF",
4
"application": "XXXXX-XXXXX",
5
"message": "XXXXXXXXXXXX",
6
"date_from": "2019-09-01",
7
"date_to": "2019-09-30"
8
}
9
}
Copied!
Like every scheduled request, /getBouncedEmails request requires an additional /getResults request.
Field
Type
Description
request_id
string
Scheduled request ID. Please check getResults method for more information.
The method will respond with a downloadable .csv file containing bounced email addresses, date and time of the bounce occurred, and the bounce reason.
CSV example with possible bounce reasons
Last modified 1mo ago