Ampersand · JSON Structure

Ampersand Api Upsert Metadata Request Structure

Request payload for upserting metadata (fields only)

Type: object Properties: 2 Required: 2
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

UpsertMetadataRequest is a JSON Structure definition published by Ampersand, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

groupRef fields

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-upsert-metadata-request-structure.json",
  "name": "UpsertMetadataRequest",
  "description": "Request payload for upserting metadata (fields only)",
  "type": "object",
  "properties": {
    "groupRef": {
      "type": "string",
      "description": "The ID that your app uses to identify the group of users for this request.",
      "example": "group-123"
    },
    "fields": {
      "type": "object",
      "description": "Maps object names to field definitions",
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/FieldDefinition"
        }
      }
    }
  },
  "required": [
    "groupRef",
    "fields"
  ]
}