Tags API
addTag
POST
https://api.pushwoosh.com/json/1.3/addTag
Creates a tag in your account.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
tag* | object | Tag parameters. |
tag.name* | string | Tag name. |
tag.type* | integer | Tag type. See possible values below. |
tag.application_specific | boolean | Defines whether the tag value should be different for multiple apps or be the same across multiple apps. |
{ "status_code": 200, "status_message": "OK", "response": { "result": true }}
{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel "tag": { "name": "TAG_NAME", // required. "type": 1, // required. See possible values below "application_specific": true, // optional. Defines whether the tag value should be different // for multiple apps or be the same across multiple apps "user_specific": true // optional. 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”
deleteTag
POST
https://api.pushwoosh.com/json/1.3/deleteTag
Completely removes a tag with all the associated information from the database.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
tag* | object | Tag parameters. |
tag.name* | string | Name of a tag to delete. |
{ "status_code": 200, "status_message": "OK", "response": { "result": true }}
{ "request": { "auth": "yxoPUlwqm…………pIyEX4H", // required. API access token from Pushwoosh Control Panel "tag": { "name": "TAG_NAME" // required. Name of a tag to delete } }}
listTags
POST
https://api.pushwoosh.com/json/1.3/listTags
Retrieves a list of tags on the account.
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
{ "status_code": 200, "status_message": "OK", "response": { "tags": [{ "name":"Language", "type":2, "isApplicationSpecific": false }, { "name":"List tag", "type":3, "isApplicationSpecific": false }] }}
{ "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”