Tags API
API methods to manage Tags

addTag

post
https://cp.pushwoosh.com/json/1.3
/addTag
/addTag
For Private Offering subscriptions only.
Example
1
{
2
"request": {
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"tag": {
5
"name": "TAG_NAME",
6
"type": 1, // see possible values below
7
"application_specific": true, // or 'false'. Defines whether the tag value should be different for multiple apps or be the same across multiple apps
8
"user_specific": true // or 'false', used for application_specific tags
9
}
10
}
11
}
Copied!
Possible tag value types:
  • 1 - Integer
  • 2 - String
  • 3 - List
  • 4 - Date
  • 5 - Boolean
  • 6 - Decimal. Ex: 19.95
  • 7 - Version. Ex: "1.0.0.0"

deleteTag

post
https://cp.pushwoosh.com/json/1.3
/deleteTag
/deleteTag
For Private Offering subscriptions only.
Example
1
{
2
"request": {
3
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
4
"tag": {
5
"name": "TAG_NAME" // name of a tag to delete
6
}
7
}
8
}
9
10
Copied!

listTags

post
https://cp.pushwoosh.com/json/1.3
/listTags
/listTags
For Private Offering subscriptions only.
Example
1
{
2
"request":{
3
"auth": "yxoPUlwqm…………pIyEX4H" // API access token from Pushwoosh Control Panel
4
}
5
}
Copied!
Tag types:
  • 1 - Integer
  • 2 - String
  • 3 - List
  • 4 - Date
  • 5 - Boolean
  • 6 - Decimal. Ex: 19.95
  • 7 - Version. Ex: "1.0.0.0"

getTags

post
https://cp.pushwoosh.com/json/1.3
/getTags
/getTags
Example
1
{
2
"request":{
3
"application": "XXXXX-XXXXX", // Pushwoosh application code
4
"hwid": "HWID", // optional, hardware device ID used in /registerDevice function call
5
"userId": "The ID of a specific user" // optional, can be used instead of "hwid" to retrieve tags for a specific user
6
}
7
}
Copied!

bulkSetTags

post
https://cp.pushwoosh.com/json/1.3
/bulkSetTags
/bulkSetTags
Example
1
{
2
"request":{
3
"application": "AAAAA-BBBBB", // Pushwoosh app code
4
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
5
"devices":[
6
{
7
"hwid":"15fbe9125b1b0c07b9315703", // hardware ID of a device
8
"tags":{ // tags to set values for
9
"Age":18, // tag name and value
10
"Name":"Anna"
11
}
12
},
13
{
14
"hwid":"ba08e11ea6485d867",
15
"tags":{
16
"Age":19,
17
"Name":"Kevin"
18
}
19
}
20
]
21
}
22
}
Copied!
To set tags for all devices associated to a particular User ID, use the "userId" parameter instead of "hwid":
Example
1
{
2
"request": {
3
"auth":"yxoPUlwq......QmpIyEX4H",
4
"application": "AAAAA-BBBBB",
5
"devices":[
6
{
7
"userId": "some_user",
8
"tags":{
9
"some boolean tag": false
10
}
11
}
12
]
13
}
14
}
Copied!
The maximum number of devices in a single request is 1000.
Last modified 1mo ago