Update subscriptions by passing one or more subscription IDs. Currently, the API supports adding and removing the tags for subscriptions.
For each tag provided in the request body:
Tags are created and inserted into the specified subscriptions if the provided tags do not map to null
and are not already present.
Tags are updated with the provided if the provided tag key is already present in a subscription, but the provided value differs from the existing value.
Tags are removed from subscriptions when a tag key is mapped to a null
tag value. The tags are removed from any subscription with a matching tag with the same key.
This API provides an asynchronous response and returns 202 Accepted
if basic input validations are successful. The location header in the response provides the URI used to fetch the progress of the subscription update task. For details about the status fetch URL, see Get progress or status of async operations in subscriptions.
Rate limits are enforced on this API. Five requests per minute are supported per workspace, and the API returns '429` if this threshold is breached.
NOTE: To call this API, you need edit permissions for the Devices and Subscription service.
Provide a map of tags
to create or delete for the given subscriptionID
(or multiple subscriptionID
's).
Tags are saved with the character casing preserved (uppercase, lowercase, mixed, and so on). However, tag searching is not case-sensitive. For example, adding a new tag with the key Location
will fail if the subscription already has a tag with the key LOCATION
as they are considered the same key.
Tag keys and tag values can comprise letters, numbers, spaces (represented in UTF-8), and only the characters: _
, .
, :
, =
, +
, -
, and @
.
NOTE: Do not store sensitive data, such as personally identifiable information, in tags.
required | object |
Request accepted
Bad request
Unauthorized request
The operation is forbidden
Validation error
Too many requests
Internal server error
The location
tag is created with San Jose
, the purchase month
tag is created with April 2023
, and the Setup Option
tag is created with Default
.
{- "tags": {
- "location": "San Jose",
- "purchase month": "April 2023",
- "Setup Option": "Default"
}
}
{- "code": 0,
- "status": "100 CONTINUE",
- "transactionId": "string"
}