REST API: Subscribers (Devices): Tags: Add or Delete
This endpoint adds or deletes tags for a device.
POST API url -> /v1/devices/tags
Body Parameters
The following body parameters are possible:
| Field | Type | Description | Required |
|---|---|---|---|
| deviceId | String | Device id. Required if customUserId is not provided. |
✅ |
| customUserId | String | Custom Id from your backend server. Required if deviceId is not provided. |
✅ |
| tags | String Array | Array of tags. | ✅ |
| add | Boolean | true - adds tags false - remove tags |
✅ |
Adding
When updating tags using add = true, you must include the complete set of tags that the device should have. Any existing tags are removed before the new tags are applied, so omitted tags will be permanently deleted.
Deleting
When deleting tags using add = false, only the provided tags are deleted (if the device has those tags).