Public API v1

Update a collection. Setting visibility to non-private auto-generates a share token.

patch/v1/collections/{collectionId}

Request

  • Base URL: https://api.mynextadventure.cloud (the document declares no server; this is the origin it was published from)
  • URL: https://api.mynextadventure.cloud/v1/collections/{collectionId}
  • Auth: API key in header X-API-Key

Path parameters

collectionIdstring required

Request body

namestring
descriptionstring
emojistring
coverImageUrlstring
visibility'private' | 'shared' | 'public'

Setting to non-private will auto-generate a share token if absent.

Response

idstring required
userIdstring required
namestring required
descriptionstring
emojistring
coverImageUrlstring
goalIdsstring[] required
visibility'private' | 'shared' | 'public' required
shareTokenstring

Opaque token for non-private collections; safe to share.

goalCountnumber required
visitedCountnumber required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.