JOjostens
Containers

Updates an existing container

Updates a container's working version with the provided configuration. The container must exist and the user must have edit permissions.

put/api/v1/containers

Request

  • Base URL
    https://jostens.com
  • Auth
    none declared

Request body */*

identifierstring

Identifier of the container. Required for updates, ignored on creation.

titlestring required

Title of the container

friendlyNamestring

Description of the container (displayed as 'Description' in the UI). Also accepts 'description' as an alias field name in JSON.

maxContentletsinteger

Maximum number of contentlets this container can hold. Set to 0 for no limit.

codestring

Velocity/code used to render the container's content. Used when maxContentlets is 0.

notesstring

Internal notes about this container (not displayed to end users)

preLoopstring

Velocity code executed before the content loop

postLoopstring

Velocity code executed after the content loop

showOnMenuboolean

Whether this container should appear in navigation menus

sortOrderinteger

Sort order for display purposes

sortContentletsBystring

Field name used to sort contentlets within this container

structureInodestring

Inode of the content type (structure) associated with this container. This is a legacy field; prefer using containerStructures for multiple content type associations.

ownerstring

Owner user ID of the container

hostIdstring

Identifier of the site (host) where this container should be created or moved to. If not provided, the container is assigned to the site resolved from the current HTTP request context.

staticifyboolean

Whether the container output should be staticified (cached as static HTML)

useDivboolean

Whether to wrap content in a div element

dynamicboolean

Whether this container uses dynamic content type resolution

Response

Container updated successfully

i18nMessagesMapobject
permissionsstring[]

Changes

Changes to this operation have not been checked yet.