sync

Preview a sync plan

Computes what a sync would import, export and remove, per platform, without executing anything. Honours the same campaign_ids scope and force flag as Trigger a sync.

The response carries a planHash. Pass it to Trigger a sync to execute exactly this plan; if anything changed in between, the trigger fails with SYNC_PLAN_DRIFT instead of running an unreviewed plan.

get/api/v1/sync/plan

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/sync/plan
  • Auth: HTTP bearer

Query parameters

platformsstring

Comma-separated platform ids, for example google-ads,microsoft-ads,reddit-ads,meta-ads,openai-ads,linkedin-ads. Defaults to every connected platform.

campaign_idsstring

Comma-separated campaign ids. Preview only these, as a scoped trigger would.

forceboolean

Preview re-exporting the in-scope campaigns even when nothing changed.

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.

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 1 revision of this API.