latestOpenAPI 3.1.02026-08-101974116.4 KB

fe3e2eee3c6f

Worlds
public

Update the details of a world

Updates the specified world and returns the resulting new world data if successful.

patch/{worldId}/

Path parameters

worldIdstring required

The ID of a world

Headers

x-m2-organization-idstring required

The ID of an organization

x-m2-project-idstring required

The ID of a project

Request body

isPublicboolean
namestring

The name of a world

descriptionstring

The description of a world

pictureUrlstring uri

Response

The updated world details

documentIdstring required

The ID of a world

namestring required

The name of a world

descriptionstring

The description of a world

pictureUrlstring uri

The picture URL of a world

transientboolean required

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.