Skip to main content
Credal | Documentation
current

Search documentation

Type to search this documentation.

On this pageOverview

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

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

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"
    }
  }
]
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu