Ampersand · Example Payload

Ampersand Api Association Definition Example

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Ampersand Api Association 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

associationTypetargetObjecttargetFieldcardinalityonDeleterequiredreverseLookupFieldName

Example Payload

Raw ↑ 
{
  "associationType": "foreignKey",
  "targetObject": "Account",
  "targetField": "example-targetField",
  "cardinality": "many-to-one",
  "onDelete": "setNull",
  "required": true,
  "reverseLookupFieldName": "example-reverseLookupFieldName"
}