Categories
Read and manage publication categories.
Get category by external ID
path Parameters
externalIdGet category by external ID › Responses
OK
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
Parent category.
Category platform.
positionCategory ordinal number in the list.
versionCategory version.
Get category by ID
path Parameters
idGet category by ID › Responses
OK
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
Parent category.
Category platform.
positionCategory ordinal number in the list.
versionCategory version.
Replace category by ID
Replaces the writable state of the addressed category.
path Parameters
idReplace category by ID › Request Body
nameCategory name.
null is invalid.
parentCategoryIdParent category ID.
See Categories for available categories. Only top-level categories can be used as parents.
Use null to keep or promote top-level placement.
Use a positive ID to move an existing subcategory under another top-level category; top-level categories reject positive parentCategoryId.
externalIdCategory ID in the external system.
Omit or set null to clear it.
Replace category by ID › Responses
OK
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
Parent category.
Category platform.
positionCategory ordinal number in the list.
versionCategory version.
Delete category by ID
Update category by ID
Partially updates the writable state of the addressed category.
path Parameters
idUpdate category by ID › Request Body
externalIdCategory ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameCategory name.
Omit to leave it unchanged. null is invalid.
parentCategoryIdParent category ID.
See Categories for available categories. Only top-level categories can be used as parents.
Omit to leave it unchanged. Set null to make or keep the category top-level. Positive IDs move subcategories only; top-level categories reject positive parentCategoryId.
Update category by ID › Responses
OK
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
Parent category.
Category platform.
positionCategory ordinal number in the list.
versionCategory version.
List categories by platform
path Parameters
platformIdquery Parameters
page0-based page number for offset pagination. Mutually exclusive with cursor.
cursor^[A-Za-z0-9._~\-]*$Opaque cursor for keyset pagination. Mutually exclusive with page. Clients must not parse or construct it; pass the nextCursor value back unchanged. Current tokens use the shared v1.BASE64... format.
sizeRequested page size. Defaults to 20 and must not exceed 100.
List categories by platform › Responses
OK
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
Create category by platform
Creates a new category for the addressed publication platform.
path Parameters
platformIdCreate category by platform › Request Body
nameCategory name.
externalIdCategory ID in the external system.
Omit or set null to leave it unset on create.
parentCategoryIdParent category ID for subcategory creation.
See Categories for available categories. Only top-level categories can be used as parents.
Omit or set null to create a top-level category.
Create category by platform › Responses
Created
externalIdCategory ID in the external system.
idCategory ID.
nameCategory name.
Parent category.
Category platform.
positionCategory ordinal number in the list.
versionCategory version.