Ampersand · Schema

JSONPatchOperation

Represents a single JSON Patch operation (RFC 6902). Only supports add, remove, and replace operations for config updates.

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name	Type	Description
op	string	The operation to perform. - "add": Adds a new field or replaces an existing one at the specified path - "remove": Removes the field at the specified path - "replace": Replaces the value at the specifi
path	string	JSON Pointer path to the field to operate on (RFC 6901). All paths must start with "/" (e.g., "/schedule", "/selectedFields/phone").
value	object	The value to set for add/replace operations. Not used for remove operations.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-json-patch-operation-schema.json",
  "title": "JSONPatchOperation",
  "description": "Represents a single JSON Patch operation (RFC 6902).\nOnly supports add, remove, and replace operations for config updates.\n",
  "type": "object",
  "properties": {
    "op": {
      "type": "string",
      "enum": [
        "add",
        "remove",
        "replace"
      ],
      "description": "The operation to perform.\n- \"add\": Adds a new field or replaces an existing one at the specified path\n- \"remove\": Removes the field at the specified path\n- \"replace\": Replaces the value at the specified path\n",
      "example": "replace"
    },
    "path": {
      "type": "string",
      "description": "JSON Pointer path to the field to operate on (RFC 6901).\nAll paths must start with \"/\" (e.g., \"/schedule\", \"/selectedFields/phone\").\n",
      "example": "/schedule"
    },
    "value": {
      "description": "The value to set for add/replace operations.\nNot used for remove operations.\n",
      "example": "*/10 * * * *"
    }
  },
  "required": [
    "op",
    "path"
  ]
}