The blog authors endpoints are used to create and manage hubspot blog authors
user_id
username
googlePlus
gravatarUrl
twitterUsername
hasSocialProfiles
GET
request to /cms/v3/blogs/authors
. You can filter and sort the authors returned in the response using the operators and properties described below. You can also use the standard filters using the createdAt and updatedAt dates.
displayName
property contains the word J__ohn using the parameter: &displayName__icontains=john
.
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 |
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 | Is like |
not_like | Not like |
icontains | Contains (case sensitive) |
startswith | Starts with |
in | In |
Operator | Description |
---|---|
id | eq , in , not_in |
fullName | eq , in , contains |
email | eq , ne , not_null |
slug | eq |
createdAt | eq , gt , gte , lt , lte |
updatedAt | eq , gt , gte , lt , lte |
name | eq , in , contains |
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.
Parameter | Description |
---|---|
translatedFromId__is_null | Primary blog author in a multi-language group. |
translatedFromId__not_null | Variation blog author in a multi-language group. |
language__in | Blog author with a specific language. |
sort=-createdAt
).
By combining query parameters for filtering, sorting, and paging, you can retrieve blog authors that match more advanced search criteria. For example, the request below fetches blog authors that don’t have a language assigned, ordered by the most recently updated. The limit and offset parameters below return the second page of results.
POST
request to /cms/v3/blogs/authors
, and include a JSON payload that represents the blog author model. The fullName
field is required when creating a blog author. To set the URL of a blog author profile page, you must provide the slug
field in your request. Review the required parameters and the structure of the blog author model in the reference documentation.
You can also create blog authors directly in your HubSpot account.
PATCH
request to /cms/v3/blogs/authors/{objectId}
, where objectId
is the ID of the associated author. Include a JSON payload representing the blog author model in your request. Review the required parameters and the structure of the blog author model in the reference documentation.
You can also edit a blog author’s profile directly in your HubSpot account.
POST
request to /multi-language/create-language-variant
and include a JSON payload containing the ID of the blog author to clone and the language identifier of the new variant.
POST
request to /multi-language/attach-to-lang-group
and include a JSON payload containing the ID of the target blog author, the language identifier of the blog author being added, and the primaryId
of the blog author designated as the primary author in the target multi-language group.
POST
request to /multi-language/detach-from-lang-group
endpoint, and include a JSON payload that contains the ID of the target blog author.