Create or Replace existing subscription tags with the provided ones
Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions.
This API can be used by partner full admins and partner admins.
Currently there is a limit of 5 tags per subscription when creating tags. To remove all the tags, pass an empty array.
Specify the customer organization ID in the orgId parameter in the URI and subscription ID in subscriptionId parameter
POST/v1/partner/tags/organizations/{orgId}/subscriptions/{subscriptionId}/assignTags
URI Parameters
orgId
stringrequired
The unique identifier for the customer organization.
subscriptionId
stringrequired
The unique identifier for the subscription.
Body Parameters
tags
array[TagsObj]
An array of tags.
name
stringrequired
Name of the tag.
description
string
Description of the tag
Response Properties
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
POST
/v1/partner/tags/organizations//subscriptions//assignTags
Log in to try the API.
Header
Body
- An array of tags.
https://webexapis.com/v1/partner/tags/organizations/Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ/subscriptions/subscriptionId/assignTags
{
"tags": [
{
"name": "Tag name","description": "Tag description"
}
]
}200 / OK
[
{
"name": "Tag name",
"description": "Tag description"
}
]