# Metadata

PATCH https://api.credal.ai/api/v0/catalog/metadata
Content-Type: application/json

Bulk patch metadata for documents, synced natively by Credal or manual API uploads

Reference: https://docs.credal.ai/api-reference/api-reference/document-catalog/metadata

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a DocumentMetadataPatchRequest.

- `sources` (list of DocumentMetadataPatch, required)
- `uploadAsUserEmail` (string, required)

## Types

### DocumentMetadataPatch

- `resourceIdentifier` (ResourceIdentifier, required) — The identifier for the resource you want to patch
- `metadata` (map from string to any, required) — Key-value object of metadata for document. Keys will be merged with any existing values but can also be set to `null` to effectively remove

### ResourceIdentifier

- `type`: `external-resource-id`
  - `externalResourceId` (string, required)
  - `resourceType` (enum, required)
    - Allowed values: `GOOGLE_DRIVE_ITEM`, `MICROSOFT_DRIVE_ITEM`, `ZENDESK_TICKET`, `ZENDESK_ARTICLE`, `ZENDESK_GROUP`, `ZENDESK_ARTICLE_SECTION`, `ZENDESK_ARTICLE_CATEGORY`, `CONFLUENCE_PAGE`, `CONFLUENCE_SPACE`, `JIRA_TICKET`, `JIRA_PROJECT`, `SALESFORCE_TASK`, `BOX_FILE`, `BOX_FOLDER`, `NOTION_PAGE`, `NOTION_DATABASE`, `SLACK_CHANNEL`, `MONGO_COLLECTION_SYNC`, `UNKNOWN`
- `type`: `url`
  - `url` (string, required)

## Examples

**Request**

```json
{
  "sources": [
    {
      "resourceIdentifier": {
        "type": "external-resource-id",
        "externalResourceId": "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
        "resourceType": "GOOGLE_DRIVE_ITEM"
      },
      "metadata": {
        "Department": "HR",
        "Country": "United States"
      }
    },
    {
      "resourceIdentifier": {
        "type": "external-resource-id",
        "externalResourceId": "123456",
        "resourceType": "ZENDESK_TICKET"
      },
      "metadata": {
        "Department": "Sales",
        "Vertical": "Healthcare"
      }
    }
  ],
  "uploadAsUserEmail": "ben@credal.ai"
}
```

**SDK Code**

```typescript Example0
import { CredalClient } from "@credal/sdk";

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.documentCatalog.metadata({
        sources: [
            {
                resourceIdentifier: {
                    type: "external-resource-id",
                    externalResourceId: "170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
                    resourceType: "GOOGLE_DRIVE_ITEM",
                },
                metadata: {
                    Department: "HR",
                    Country: "United States",
                },
            },
            {
                resourceIdentifier: {
                    type: "external-resource-id",
                    externalResourceId: "123456",
                    resourceType: "ZENDESK_TICKET",
                },
                metadata: {
                    Department: "Sales",
                    Vertical: "Healthcare",
                },
            },
        ],
        uploadAsUserEmail: "ben@credal.ai",
    });
}
main();

```

```python Example0
from credal import CredalV0
from credal.document_catalog import DocumentMetadataPatch
from credal.common import ResourceIdentifier_ExternalResourceId

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.document_catalog.metadata(
    sources=[
        DocumentMetadataPatch(
            resource_identifier=ResourceIdentifier_ExternalResourceId(
                external_resource_id="170NrBm0Do7gdzvr54UvyslPVWkQFOA0lgNycFmdZJQr",
                resource_type="GOOGLE_DRIVE_ITEM",
            ),
            metadata={
                "Department": "HR",
                "Country": "United States"
            },
        ),
        DocumentMetadataPatch(
            resource_identifier=ResourceIdentifier_ExternalResourceId(
                external_resource_id="123456",
                resource_type="ZENDESK_TICKET",
            ),
            metadata={
                "Department": "Sales",
                "Vertical": "Healthcare"
            },
        )
    ],
    upload_as_user_email="ben@credal.ai",
)

```

## Related pages

- [Credal | Documentation](../index.md)
- [Overview](./api-reference-v-0-overview.md)
- [Docs](../guides.md)
- [Introduction](./getting-started-introduction.md)
- [API Reference](./api-reference-index.md)
- [Service Accounts](./api-reference-v-0-service-accounts.md)
- [Quickstart](./getting-started-quickstart.md)
- [Overview](./api-reference-v-1-overview.md)
- [Overview](./getting-started-tutorials-common-first-agents-employee-onboarding-assistant-overview.md)
- [OAuth Setup](./api-reference-v-1-o-auth-setup.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.