Metadata

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

Bulk patch metadata for users

Reference: https://docs.credal.ai/api-reference/api-reference/users/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 list of UserMetadataPatch.

list of UserMetadataPatch

Types

UserMetadataPatch

userEmail (string, required)
metadata (map from string to any, required) — Key-value object of metadata for user. Keys will be merged with any existing values but can also be set to null to effectively remove

Examples

Request

JSON

[
  {
    "userEmail": "ravin@credal.ai",
    "metadata": {
      "State": "NY",
      "Job Role": "CEO"
    }
  },
  {
    "userEmail": "jack@credal.ai",
    "metadata": {
      "State": "NY",
      "Department": "Engineering"
    }
  }
]

SDK Code

Example0

import { CredalClient } from "@credal/sdk";

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.users.metadata([
        {
            userEmail: "ravin@credal.ai",
            metadata: {
                State: "NY",
                "Job Role": "CEO",
            },
        },
        {
            userEmail: "jack@credal.ai",
            metadata: {
                State: "NY",
                Department: "Engineering",
            },
        },
    ]);
}
main();

Example0

from credal import CredalV0
from credal.users import UserMetadataPatch

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.users.metadata(
    request=[
        UserMetadataPatch(
            user_email="ravin@credal.ai",
            metadata={
                "State": "NY",
                "Job Role": "CEO"
            },
        ),
        UserMetadataPatch(
            user_email="jack@credal.ai",
            metadata={
                "State": "NY",
                "Department": "Engineering"
            },
        )
    ],
)