Tags API
API methods to manage Tags
To set tag values for HWIDs and UserIDs, use the /setTags method from Device API.
addTag
/addTag
POST
https://api.pushwoosh.com/json/1.3/addTag
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. |
Creates a tag in your account.
For Custom Plan subscriptions only. For more details, please contact our Sales team.
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
/deleteTag
POST
https://api.pushwoosh.com/json/1.3/deleteTag
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. |
Completely removes a tag with all the associated information from the database.
For Custom Plan subscriptions only. For more details, please contact our Sales team.
listTags
/listTags
POST
https://api.pushwoosh.com/json/1.3/listTags
Request Body
Name | Type | Description |
---|---|---|
auth* | string | API access token from Pushwoosh Control Panel. |
Retrieves a list of tags on the account.
For Custom Plan subscriptions only. For more details, please contact our Sales team.
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
/getTags
POST
https://go.pushwoosh.com/json/1.3/getTags
Request Body
Name | Type | Description |
---|---|---|
application* | string | Pushwoosh application code. |
userId | string | User identifier to be used instead of "hwid". If used together with a "hwid", the "hwid" prevails. |
hwid | string | Hardware device ID used in /registerDevice request. |
Retrieves a list of tags with corresponding values for the specific device.
bulkSetTags
/bulkSetTags
POST
https://api.pushwoosh.com/api/v2/audience/bulkSetTags
Request Body
Name | Type | Description |
---|---|---|
application* | String | Pushwoosh app code. |
auth* | String | API access token from Pushwoosh Control Panel. |
create_missing_tags | Boolean | If true, missing tags are created automatically. |
devices* | Object | Array of devices. |
devices.hwid | String | Can be used to identify a device instead of user_id or push_token |
devices.user_id | String | Can be used to identify a user instead of hwid or push_token |
devices.push_token | String | Can be used to identify a device instead of hwid or user_id |
devices.list_operator | String | Defines how to set values for tags of the list type: set, append, or remove |
devices.tags* | Object | Values to set for the tags specified. |
Sets tag values for the list of devices.
/bulkSetTags status
GET
https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false
Path Parameters
Name | Type | Description |
---|---|---|
request_id | String | request id from previous /bulkSetTags call |
Query Parameters
Name | Type | Description |
---|---|---|
detailed | Boolean | (true/false) whether to return detailed per-device info |
Returns the status of /bulkSetTags operation
Last updated