Validate a mappings document
The authoritative compatibility check: field type compatibility, required and orphaned fields, linked-record constraints, create-placeholder feasibility, and everything the mappings PUT would enforce — as one issue list with stable codes and document paths. Side-effect-free: create placeholders are checked, never executed. Send a candidate document, or an empty body to validate the stored one. Referenced tables whose fields were never fetched are fetched during the call, so a first validate can take a few seconds. Two failure channels: a structurally malformed document (wrong types, bad direction, a create on both sides) is a 400 invalid_mappings naming the path — everything semantic about a well-formed document comes back as a 200 with issues.
Request
- Base URL: https://api.whalesync.com
- URL: https://api.whalesync.com/v1/sync/syncs/{sync_id}/validate
- Auth: HTTP bearer
Path parameters
Request body
Example request
{
"tables": [
{
"left": {
"view": "viwActive"
},
"right": {
"view": "viwActive"
},
"filter": {
"conditions": [
{
"left_field": "fldStage",
"right_field": "stage"
}
],
"summary": "Only records where Stage is \"Won\" and Amount is at least \"100\" are synced.",
"docs_url": "https://docs.whalesync.com/features/filters"
}
}
]
}Response
The issues found; empty means valid.
Example response
{
"issues": [
{
"code": "incompatible_field_types",
"path": "/tables/0/fields/1"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.