Collections

Update a collection

Renames a collection, moves it to another parent or changes its order.

Tool

filmo_collections_update

Writecollections:write

collections:write
120/min
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_collections_update",
    "arguments": {
      "collectionId": "coll_8f2a1c"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "updated": true
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

entityType is not there: changing it is not supported. A parentCollectionId that does not exist or belongs to another account, that is the collection itself or one of its subcollections, or that groups a different type of resource responds 400 validation_error with errors[0].path on that field; the system collections cannot be modified (409 conflict). In both cases nothing is written. Returns the confirmation, not the record, because this resource does not publish a read.

Arguments

collectionIdstringRequired

Collection identifier.

Limits: min length 1

namestring

Collection name.

Limits: min length 1

descriptionstring

Collection description.

parentCollectionIdstring | null

New parent collection; null moves it to the top level.

iconstring

Collection icon.

ordernumber

Display order among its siblings.

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Identifier of the updated collection.

updatedboolean

true when the change was applied.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs PATCH /api/v1/collections/{collectionId}.

Collections
Update a collection
Renames a collection, moves it to another parent or changes its order.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Update a collection

Safe writes

Errors