Perform create, read, update, and delete actions on CMS Hub blog tags using the blog tags API.
description
property has been deprecated and will not be included in the response of any of the V3 endpoints.
GET
request to /cms/v3/blogs/tags
. You can filter and sort the tags returned in the response using the operators and properties below. You can also use the standard filters using the createdAt
and updatedAt
dates.
name
property contains the word marketing using the parameter: &name__icontains=marketing
.
You can include any number of filters as query parameters in the request URL. All filters are ANDed together. ORing filters is not currently supported.
The available filter types are listed below:
Operator | Description |
---|---|
eq | Equal to |
ne | Not equal to |
contains | Contains |
icontains | Contains (case sensitive) |
lt | Less than |
lte | Less than or equal to |
gt | Greater than |
gte | Greater than or equal to |
is_null | Null |
not_null | Not null |
like | Like |
not_like | Not like |
startswith | Value starts with |
in | In |
Property | Supported filters |
---|---|
id | eq, in |
name | eq, contains |
slug | eq |
createdAt | eq, gt, gte, lt, lte |
deletedAt | eq, gt, gte, lt, lte |
createdById | eq |
updatedById | eq |
language | in, not_null |
translatedFromId | null, not_null |
language__in=de
as a query parameter.
en-us
) are not supported with the language
filter.sort=-createdAt
).
By combining query parameters for filtering, sorting, and paging, you can retrieve blog tags that match more advanced search criteria. For example, the request below fetches blog tags that have a language assigned, ordered by the most recently updated. Including the limit
and offset
parameters below returns the second page of results.
POST
request to /cms/v3/blog/posts
and include a JSON payload that represents the blog tag model, as shown in the reference documentation. The name
field is required when creating a blog tag. To set the URL of a blog tag listing page, you must include the slug
field in your request.
PATCH
request to /cms/v3/blog/posts/{objectId}
where objectId
is the ID of the tag you want to update. In your request, include a JSON payload should include the blog tag model, as shown in the reference documentation.
POST
request to /multi-language/create-language-variant
and include a JSON payload containing the ID of the blog tag to clone and the language identifier of the new variant.
POST
request to the /multi-language/attach-to-lang-group
and include a JSON payload containing the ID of the target blog tag, the language identifier of the blog tag being added, and the primaryId
of the blog tag designated as the primary blog tag in the target multi-language group.
POST
request to /multi-language/detach-from-lang-group
and include a JSON payload containing the ID of the target blog tag.