Request

Response

    Update Saved Search Group
    PATCH

    v2/hubs/{hubId}/saved-search-groups/{savedSearchGroupId}

    Partially updates an existing Saved Search Group in a hub using the JSON Patch standard (RFC 6902). Only the fields specified in the patch operations are updated; omitted fields remain unchanged.

    Only the replace operation is supported (the request schema does not accept add, remove, move, copy, or test). Patchable paths: /name. The /scope field is immutable and any other path is rejected with 400.

    Resource Information

    Method and URI
    PATCH
    https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/saved-search-groups/{savedSearchGroupId}
    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
    Hub ID that owns the saved search group (UUID format, uppercase)
    savedSearchGroupId
    string
    Unique identifier of the saved search group (UUID format, uppercase)

    Request

    Body Structure

    JSON Patch operations to apply

    op*
    enum:string
    The operation to perform. Only replace is supported. Will always be: replace
    path*
    string
    JSON Pointer to the target field
    value*
    object
    The replacement value for the target field
    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    Saved Search Group successfully updated
    400
    Bad Request
    The server was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
    403
    Forbidden
    The request was successfully validated, but lacking the required permissions. Verify your credentials and permissions before you send the request again.
    404
    Not Found
    The requested resource was not found. Review the request and try again.
    409
    Conflict
    A saved search group with the same name already exists. Uniqueness is enforced as follows: HUB scope — one group per name per hub (any creator); PERSONAL scope — one group per name per hub and owner. Use a different name and try again.
    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.
    503
    Service Unavailable
    The service is temporarily unavailable. Retry the request after a short delay.

    Response

    Body Structure (200)

    Expand all
    id
    string
    Unique identifier of the saved search group (UUID format, uppercase)
    hubId
    string
    Unique identifier of the hub that owns this saved search group (UUID format, uppercase)
    scope
    enum:string
    Visibility and ownership scope. HUB groups are visible to and usable by every member of the hub, but only hub admins may create, update, or delete them. PERSONAL groups are visible only to their creator, who is the only one who can manage them — not even hub admins can see or act on another user’s personal groups. Possible values: PERSONAL, HUB
    name
    string
    Saved Search Group name
    permissions
    object
    Permissions the requesting user has on this saved search group
    canRead
    boolean
    Whether the user can read this saved search group
    canEdit
    boolean
    Whether the user can edit this saved search group
    canDelete
    boolean
    Whether the user can delete this saved search group
    createdBy
    string
    Creator identifier (Autodesk ID)
    updatedBy
    string
    Last modifier identifier (Autodesk ID)
    createdAt
    datetime: ISO 8601
    Creation timestamp
    updatedAt
    datetime: ISO 8601
    Last update timestamp

    Example

    Saved Search Group successfully updated

    Request

    curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/123E4567-E89B-12D3-A456-426614174000/saved-search-groups/A1B2C3D4-E5F6-7890-ABCD-EF1234567890' \
      -X 'PATCH' \
      -H 'Authorization: ' \
      -H 'Content-Type: application/json-patch+json' \
      -d '[
            {
              "op": "replace",
              "path": "/name",
              "value": "My Saved Searches"
            }
          ]'
    
    Show More

    Response

    {
      "id": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
      "hubId": "757FF58F-AE23-42D8-B303-BD7B53FA2B98",
      "scope": "PERSONAL",
      "name": "My Saved Searches",
      "permissions": {
        "canRead": true,
        "canEdit": true,
        "canDelete": true
      },
      "createdBy": "AKB2JV55N3SQ55DT",
      "updatedBy": "AKB2JV55N3SQ55DT",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-16T14:20:00Z"
    }
    
    Show More