Validate a campaign before export

Runs the same checks a sync runs before it exports, without calling any platform. Use it before Trigger a sync so a refusal shows up here rather than inside a sync record.

Returns valid (true when nothing blocks the export), platforms (the ids checked) and findings[], ordered worst first: blocked, unsupported, degraded, ok. Each finding also has a kind that says what it is:

  • requirement: something you must fix before this platform accepts the campaign.
  • transform: the platform will receive a changed version (a clamped value, for example).
  • limitation: a permanent trait of the platform; nothing to fix.
  • suggestion: an optional improvement.

Only requirement findings need your attention. Body platforms defaults to the platforms the campaign runs on; naming a platform validates against it even when it is not connected.

Errors

  • 404 NOT_FOUND: no campaign with this id in the active Space.
  • 400 UNKNOWN_PLATFORM: a platform id in the body does not exist.
post/api/v1/campaigns/{id}/validate-export

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/campaigns/{id}/validate-export
  • Auth: HTTP bearer

Path parameters

idstring required

The campaign id.

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Request body

platformsstring[]

Platform ids to validate against, for example google-ads. Defaults to the platforms the campaign runs on.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.