Ampersand · JSON Structure

Ampersand Api Field Upsert Result Structure

Result of an upsert operation for a single field

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

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

Properties

fieldName action metadata warnings

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-field-upsert-result-structure.json",
  "name": "FieldUpsertResult",
  "description": "Result of an upsert operation for a single field",
  "type": "object",
  "properties": {
    "fieldName": {
      "type": "string",
      "description": "Name of the field"
    },
    "action": {
      "type": "string",
      "description": "Action taken (create, update, none)"
    },
    "metadata": {
      "type": "object",
      "description": "Provider-specific metadata about the field",
      "additionalProperties": true
    },
    "warnings": {
      "type": "array",
      "description": "Warnings that occurred during the upsert operation",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "fieldName",
    "action"
  ]
}