Skip to main content

User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

Update collection​

Update an existing collection.

Path Parameters
    collectionId string required

    The Id of the collection to be updated.

Request Body
    name string required

    Possible values: non-empty and <= 255 characters

    The new name of the collection to be updated.

Responses

Request has been handled successfully.

Response Headers
  • X-Mutation-At string

    Effective user mutation head in Unix milliseconds. GET returns its observed sync head; writes capture it inside their serialized database operation, before releasing the user lock. Effective writes advance it; no-ops may retain it. Successful publication uses the final attachment transaction; partial publication retains the private-write or pre-publication baseline head. A concurrent write may make it stale before receipt, so POST /v1/sync can still return 409. Use it only as an optimistic write precondition, never as a pull watermark. See the Sync API guide for how sync clients store and use it.


Schema
    success boolean
    data object
    message

    Possible values: [collection renamed]

Loading...