Tags

API methods to manage Tags

post
/addTag

https://cp.pushwoosh.com/json/1.3/addTag
Creates a new tag in the database.
Request
Response
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
tag
required
object
Tag parameters.
tag.name
required
string
Tag name.
tag.type
required
integer
Tag type. See possible values below.
tag.application_specific
optional
boolean
Defines whether the tag value should be different for multiple apps or be the same across multiple apps.
200: OK
{
"status_code": 200,
"status_message": "OK",
"response": {
"result": true
}
}

For Private Offering subscriptions only.

Example
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
"tag": {
"name": "TAG_NAME",
"type": 1, // see possible values below
"application_specific": true, // or 'false'. Defines whether the tag value should be different for multiple apps or be the same across multiple apps
"user_specific": true // or 'false', used for application_specific tags
}
}
}

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"

post
/deleteTag

https://cp.pushwoosh.com/json/1.3/deleteTag
Completely removes a tag with all the associated information from the database.
Request
Response
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
tag
required
object
Tag parameters.
tag.name
required
string
Name of a tag to delete.
200: OK
{
"status_code": 200,
"status_message": "OK",
"response": {
"result": true
}
}

For Private Offering subscriptions only.

Example
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
"tag": {
"name": "TAG_NAME" // name of a tag to delete
}
}
}

post
/listTags

https://cp.pushwoosh.com/json/1.3/listTags
Retrieves a list of tags on the account.
Request
Response
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
200: OK
{
"status_code":200,
"status_message":"OK",
"response":{
"tags":[
{
"name":"Language",
"type":2,
"isApplicationSpecific": false
},
{
"name":"List tag",
"type":3,
"isApplicationSpecific": false
}
]
}
}

For Private Offering subscriptions only.

Example
{
"request":{
"auth": "yxoPUlwqm…………pIyEX4H" // API access token from Pushwoosh Control Panel
}
}

Tag types:

  • 1 - Integer

  • 2 - String

  • 3 - List

  • 4 - Date

  • 5 - Boolean

  • 6 - Decimal. Ex: 19.95

  • 7 - Version. Ex: "1.0.0.0"