MEmetabase
/api/exploration

PUT /api/exploration/{id}

Changed on

Update an exploration's metadata, archive state, or move it to a different collection.

When collection_id changes, the caller must have write perms on the destination collection (or the root collection when collection_id is nil). Source perms are enforced by api/write-check against the exploration itself via :perms/use-parent-collection-perms. Moving an exploration cascades the new collection_id onto its Summary document; flipping archived cascades to the same document (skipping any that were directly user-archived, mirroring the dashboard / dashboard-question cascade).

put/api/exploration/{id}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

archivedboolean
collection_idinteger nullable

value must be an integer greater than zero.

collection_positioninteger nullable

value must be an integer greater than zero.

descriptionstring nullable
namestring

value must be a non-blank string between 1 and 254 characters.

Response

Successful response

archivedboolean
can_deleteboolean
can_restoreboolean
can_writeboolean
collection_idinteger nullable

value must be an integer greater than zero.

created_atunknown
creatorobject nullable
creator_idinteger required

value must be an integer greater than zero.

descriptionstring nullable
idinteger required

value must be an integer greater than zero.

namestring required
updated_atunknown

Changes