Rivier/ Reference/ files

Rename or describe a collection

patch/assets/collections/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
files:write
Graphql
Mutation.filesCollectionUpdate
Sdk
files.collection.update
Cli
files collection update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestring
    At most 120 characters.
  • kindstring
    One of: set, character, campaign, kit, series, custom.
  • descriptionstring
    At most 1000 characters.

Responses

  • 200application/json
    Success
    • collectionobjectrequired
      • idstring (uuid)required
      • namestringrequired
      • kindstringrequired
        One of: set, character, campaign, kit, series, custom.
      • descriptionstringrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown