Skip to main content
POST
/
resource-collections
/
batch
curl -X POST 'https://api.example.com/resource-collections/batch' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "scopeId": "scope_org",
      "resourceTypeId": "rtype_document",
      "name": "Finance Documents",
      "matchDefinition": {
        "tags": { "department": "finance" }
      }
    },
    {
      "scopeId": "scope_org",
      "resourceTypeId": "rtype_document",
      "name": "Legal Documents",
      "matchDefinition": {
        "tags": { "department": "legal" }
      }
    }
  ]'

[
  {
    "id": "collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "scopeId": "scope_org",
    "resourceTypeId": "rtype_document",
    "name": "Finance Documents",
    "matchDefinition": {
      "tags": { "department": "finance" }
    },
    "createdAt": "2024-01-15T10:30:00Z"
  },
  {
    "id": "collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5c",
    "scopeId": "scope_org",
    "resourceTypeId": "rtype_document",
    "name": "Legal Documents",
    "matchDefinition": {
      "tags": { "department": "legal" }
    },
    "createdAt": "2024-01-15T10:30:00Z"
  }
]

​
Request Body

Array of resource collection objects to create.
​
[].id
string
Optional client-provided ID. Format: collection_{uuidv7}
​
[].scopeId
string
required
ID of the scope where collection is defined
​
[].resourceTypeId
string
required
ID of the resource type for this collection
​
[].name
string
required
Display name for the collection
​
[].description
string
Description of what this collection represents
​
[].matchDefinition
object
required
Rules for matching resources to this collection

​
Response

Returns an array of created resource collection objects. 
curl -X POST 'https://api.example.com/resource-collections/batch' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "scopeId": "scope_org",
      "resourceTypeId": "rtype_document",
      "name": "Finance Documents",
      "matchDefinition": {
        "tags": { "department": "finance" }
      }
    },
    {
      "scopeId": "scope_org",
      "resourceTypeId": "rtype_document",
      "name": "Legal Documents",
      "matchDefinition": {
        "tags": { "department": "legal" }
      }
    }
  ]'

[
  {
    "id": "collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "scopeId": "scope_org",
    "resourceTypeId": "rtype_document",
    "name": "Finance Documents",
    "matchDefinition": {
      "tags": { "department": "finance" }
    },
    "createdAt": "2024-01-15T10:30:00Z"
  },
  {
    "id": "collection_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5c",
    "scopeId": "scope_org",
    "resourceTypeId": "rtype_document",
    "name": "Legal Documents",
    "matchDefinition": {
      "tags": { "department": "legal" }
    },
    "createdAt": "2024-01-15T10:30:00Z"
  }
]