Ampersand · Example Payload

Ampersand Api Field Definition Example

example-description

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Ampersand Api Field Definition Example is an example object payload from Ampersand, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

fieldNamedisplayNamedescriptionvalueTyperequireduniqueindexed

Example Payload

Raw ↑ 
{
  "fieldName": "My_Custom_Field",
  "displayName": "My Custom Field",
  "description": "example-description",
  "valueType": "string",
  "required": true,
  "unique": true,
  "indexed": true
}