sync

Unlink campaigns from a platform

Forgets the link between local campaigns and their copies on one platform, keeping the local campaigns. With deleteRemote: true the platform copies are removed as well. The next sync re-creates the campaigns on the platform from scratch, which is the clean way to recover from a campaign that was deleted or broken on the platform side.

The response maps each campaign id to its result; a campaign that was not linked reports not_linked.

Errors

  • 400 VALIDATION_ERROR: the body failed validation; details.issues[] names each field.
post/api/v1/sync/unlink

Request

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

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

platformstring required

Platform id, for example google-ads.

campaignIdsstring[]

Campaigns to unlink. Omit to unlink every campaign linked to the platform.

deleteRemoteboolean

Also remove the campaign on the platform. A campaign that is already gone there counts as removed. When false, only the local link is cleared and the platform copy is left untouched.

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.