Array of field paths specifying which fields to update.
Uses dot notation for nested fields (e.g., "config.revision", "metadata.tags").
**Field Path Rules:**
- Use dot notation for nested objects: `parent.child.field`
- Escape special characters: `field\.with\.dots`, `field\:with\:colons`
- Array elements not directly addressable
- Object names can be specified directly (e.g., "config.content.read.objects.contacts")
- The * operator in paths like "config.content.read.objects.*" allows you to specify any object name
- Example: "config.content.read.objects.*" pattern allows "config.content.read.objects.contacts", "config.content.read.objects.leads", etc.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-update-mask-structure.json",
"name": "UpdateMask",
"description": "Array of field paths specifying which fields to update.\nUses dot notation for nested fields (e.g., \"config.revision\", \"metadata.tags\").\n\n**Field Path Rules:**\n- Use dot notation for nested objects: `parent.child.field`\n- Escape special characters: `field\\.with\\.dots`, `field\\:with\\:colons`\n- Array elements not directly addressable\n- Object names can be specified directly (e.g., \"config.content.read.objects.contacts\")\n- The * operator in paths like \"config.content.read.objects.*\" allows you to specify any object name\n - Example: \"config.content.read.objects.*\" pattern allows \"config.content.read.objects.contacts\", \"config.content.read.objects.leads\", etc.\n",
"type": "array",
"items": {
"type": "string"
},
"example": [
"name",
"config.content.read.objects.contacts",
"config.content.write.objects.leads"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.