Request

Response

    Update a collection
    PATCH

    v2/hubs/{hubId}/collections/{collectionId}

    Updates a collection using JSON Patch operations (RFC 6902).

    Only the following top-level paths may be modified, each via replace: - /name — display name - /description — description - /groupAssignments — whole-object replace, following the same rules as on create.

    Only the Content Catalog admin group can change group assignments; the hub admin group is always added to each of the four arrays regardless of what is sent, so it never needs to be listed.

    Patching any other path is not supported.

    Resource Information

    Method and URI
    PATCH
    https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/collections/{collectionId}
    Authentication Context
    user context required
    Required OAuth Scopes
    data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account flow.

    The Secure Service Account (SSA) flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    Region
    string
    Region identifier for API routing. Defaults to US if not provided.
    Content-Type*
    string
    Must be application/json-patch+json
    * Required

    Request

    URI Parameters

    hubId
    string: UUID
    Hub ID that owns the collection
    collectionId
    string: UUID
    Collection ID to update

    Request

    Body Structure

    op*
    enum:string
    The operation to perform. Only replace is supported for collections. Will always be: replace
    path*
    string
    JSON Pointer to the target field. Only /name and /description can be changed.
    value
    object
    The value to use for the operation. May be null where the target path accepts it.
    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    Collection updated successfully
    403
    Forbidden
    Unauthorized
    404
    Not Found
    The requested resource was not found. Review the request and try again.
    412
    Precondition failed
    500
    Internal Server Error
    An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance.

    Response

    Body Structure (200)

    Expand all
    id
    string
    Unique identifier for the collection (UUID format, uppercase)
    hubId
    string
    Hub (account) that owns this collection (UUID format, uppercase)
    name
    string
    Display name for the collection (stored as Name in GraphQL)

    Max length: 255

    description
    string
    Detailed description of the collection

    Max length: 2000

    createdBy
    string
    User ID who created this collection
    createdAt
    datetime: ISO 8601
    Creation timestamp
    updatedAt
    datetime: ISO 8601
    Last update timestamp
    updatedBy
    string
    User ID who last updated this collection
    channelSubscription
    object
    For future use. Identifies the publisher channel this collection is subscribed to. Both fields are required and must be valid UUIDs. This object is invariant — when provided, both fields must be present. If the created collection is not a channel subscription, this field must be null.
    channelId
    string: UUID
    The publisher’s channel (collection) ID
    publisherId
    string: UUID
    The publisher’s hub (company) ID
    groupAssignments
    object
    Groups assigned to different permission levels for a collection. Each field is an array of group IDs (UUIDs or special identifiers like “-ACCOUNT-UUID” for company-wide access).
    readGroups
    array: string
    Group IDs with read access to this collection
    editGroups
    array: string
    Group IDs with edit access to this collection
    uploadGroups
    array: string
    Group IDs with upload access to this collection
    downloadInsertGroups
    array: string
    Group IDs with download/insert access to this collection
    permissions
    object
    Current user’s resolved permissions for this collection. This field is read-only and computed server-side based on the user’s group memberships. For admin users, all permissions are true.
    canRead
    boolean
    Whether the current user can view this collection
    canDownloadInsert
    boolean
    Whether the current user can download/insert content from this collection
    canUpload
    boolean
    Whether the current user can upload content to this collection
    canEdit
    boolean
    Whether the current user can edit this collection’s metadata

    Example

    Collection updated successfully

    Request

    curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/A122B37C-D8CD-497C-9DF3-24971A4C17BB/collections/C652DFB6-2A4B-4AFC-8572-892DCCC3577F' \
      -X 'PATCH' \
      -H 'Authorization: ' \
      -H 'Content-Type: application/json-patch+json' \
      -d '[
            {
              "op": "replace",
              "path": "/name",
              "value": "Air Handler Units"
            },
            {
              "op": "replace",
              "path": "/description",
              "value": "Approved Air Handler Units for hospital projects."
            },
            {
              "op": "replace",
              "path": "/groupAssignments",
              "value": {
                "readGroups": [
                  "6A10A175-3374-4586-BADB-182D40747ECC"
                ],
                "editGroups": [],
                "uploadGroups": [],
                "downloadInsertGroups": []
              }
            }
          ]'
    
    Show More

    Response

    {
      "id": "C652DFB6-2A4B-4AFC-8572-892DCCC3577F",
      "hubId": "A122B37C-D8CD-497C-9DF3-24971A4C17BB",
      "name": "Air Handler Units",
      "description": "Approved Air Handler Units for hospital projects.",
      "createdBy": "7VYJW2XPP7DJQGZW",
      "createdAt": "2024-01-29T10:30:00.000Z",
      "updatedAt": "2024-02-05T09:15:00.000Z",
      "updatedBy": "7VYJW2XPP7DJQGZW",
      "channelSubscription": null,
      "groupAssignments": {
        "readGroups": [
          "A122B37C-D8CD-497C-9DF3-24971A4C17BB",
          "6A10A175-3374-4586-BADB-182D40747ECC"
        ],
        "editGroups": [
          "A122B37C-D8CD-497C-9DF3-24971A4C17BB"
        ],
        "uploadGroups": [
          "A122B37C-D8CD-497C-9DF3-24971A4C17BB"
        ],
        "downloadInsertGroups": [
          "A122B37C-D8CD-497C-9DF3-24971A4C17BB"
        ]
      },
      "permissions": {
        "canRead": true,
        "canDownloadInsert": true,
        "canUpload": true,
        "canEdit": true
      }
    }
    
    Show More