deleteCustomTags
deleteCustomTags(BatchTagsRequestDto)
DELETE /api/2.0/files/tags
Delete the custom room tags
Deletes custom room tags from the portal catalog by name and detaches them from every room that carries them; the rooms themselves and their content are untouched, and only the tag disappears from their tag lists. Only a portal administrator may call it, and a room manager who is allowed to create tags is refused. The names are matched exactly as they are stored: names that are not in the catalog are skipped in silence and an empty list is accepted as a no-op, so a successful answer does not prove that anything was deleted; check a name with GET api/2.0/files/tags/{tagName}/haslinks first when that matters. The call cannot be undone: creating the name again with POST api/2.0/files/tags brings back the tag but not its links, which have to be attached to each room once more. The answer carries no body. To take a tag off one room and leave it in the catalog for the others, use DELETE api/2.0/files/rooms/{id}/tags instead.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| BatchTagsRequestDto | body | BatchTagsRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The tags were removed from the catalog and from every room | - | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no names, or a name is empty, blank or longer than 255 characters | - | - |
| 403 | Only a portal administrator can delete tags | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
null (empty response body)
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json