Types
Read and manage publication types.
List types 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 types 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 type by platform
Creates a new type for the addressed publication platform.
path Parameters
platformIdCreate type by platform › Request Body
nameType name.
externalIdType ID in the external system.
Omit or set null to leave it unset on create.
Create type by platform › Responses
Created
externalIdType ID in the external system.
idType ID.
nameType name.
Type platform.
Replace type by ID
Replaces the writable state of the addressed type.
path Parameters
idReplace type by ID › Request Body
nameType name.
null is invalid.
externalIdType ID in the external system.
Omit or set null to clear it.
Replace type by ID › Responses
OK
externalIdType ID in the external system.
idType ID.
nameType name.
Type platform.
Update type by ID
Partially updates the writable state of the addressed type.
path Parameters
idUpdate type by ID › Request Body
externalIdType ID in the external system.
Omit to leave it unchanged. Set null to clear it.
nameType name.
Omit to leave it unchanged. null is invalid.
Update type by ID › Responses
OK
externalIdType ID in the external system.
idType ID.
nameType name.
Type platform.