Skip to main content
PATCH
/
resource-collections
/
{id}
curl -X PATCH 'https://api.example.com/resource-collections/collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Finance & Accounting Documents",
    "matchDefinition": {
      "tags": {
        "department": ["finance", "accounting"]
      }
    }
  }'

{
  "id": "collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "scopeId": "scope_org",
  "resourceTypeId": "rtype_document",
  "name": "Finance & Accounting Documents",
  "description": "All documents tagged with finance department",
  "matchDefinition": {
    "tags": {
      "department": ["finance", "accounting"]
    }
  },
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Path Parameters

​
id
string
required
The resource collection ID

​
Request Body

​
name
string
Display name for the collection
​
description
string
Description of what this collection represents
​
matchDefinition
object
Rules for matching resources (replaces existing definition)

​
Response

Returns the updated resource collection object. 
curl -X PATCH 'https://api.example.com/resource-collections/collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Finance & Accounting Documents",
    "matchDefinition": {
      "tags": {
        "department": ["finance", "accounting"]
      }
    }
  }'

{
  "id": "collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "scopeId": "scope_org",
  "resourceTypeId": "rtype_document",
  "name": "Finance & Accounting Documents",
  "description": "All documents tagged with finance department",
  "matchDefinition": {
    "tags": {
      "department": ["finance", "accounting"]
    }
  },
  "createdAt": "2024-01-15T10:30:00Z"
}