---
title: "Unlink campaigns from a platform"
method: POST
path: "/api/v1/sync/unlink"
tags: ["sync"]
---

# Unlink campaigns from a platform

`POST /api/v1/sync/unlink`

## Request

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

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.

## Headers

- `X-Space-Id` string

## Request body

- SyncUnlinkRequest: Forget the link between local campaigns and their copies on one platform. The local campaigns are kept; the next sync re-creates them on the platform.
  - `platform` string, required: Platform id, for example `google-ads`.
  - `campaignIds` string[]: Campaigns to unlink. Omit to unlink every campaign linked to the platform.
  - `deleteRemote` boolean: 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 `200`

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

- SuccessEnvelope: The shape of every successful response.
  - `data` unknown, required
  - `meta` object: Present on list responses.
    - `nextCursor` union: Pass as `cursor` to get the next page. `null` on the last page.
      - string
      - number
    - `total` integer: Number of items in this page.

## Other responses

- `201`: Created. The new resource is in `data`.
- `400`: The request is malformed or fails validation. `error.code` is `VALIDATION_ERROR` (with `details.issues[]` naming each field), `INVALID_REQUEST` (the body is not valid JSON or has the wrong shape), or one of the specific codes listed in this operation's description.
- `401`: The bearer token is missing, invalid, expired or revoked (`INVALID_TOKEN`).
- `403`: The token lacks the scope this operation needs (`INSUFFICIENT_SCOPE`), the plan is read-only (`READ_ONLY_MODE`), or the caller is not a member of the Space named in `X-Space-Id` (`NOT_A_MEMBER`).
- `404`: No such resource in the active Space (`NOT_FOUND`), or `X-Space-Id` names a Space that does not exist (`SPACE_NOT_FOUND`).
- `409`: The request conflicts with the current state, for example a delete blocked by dependents or a sync already running. This operation's description names the `error.code` values it can return.
- `429`: Too many requests (`RATE_LIMITED`). Wait for the number of seconds in the `Retry-After` header, then retry.

---

[API](https://skmtc.dev/growomat/apis/growomat-public-api.md) · [All operations](https://skmtc.dev/growomat/apis/growomat-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/growomat/apis/growomat-public-api/revisions/f02611b531aa?raw)