Pause all Google Ads campaigns

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Stops every campaign on the account serving, in one call. Useful as a spend kill switch.

The response reports how many campaigns paused out of how many were tried. A status of partial means at least one did not pause and is still serving. The call does not roll the others back, so retry it or pause the remaining campaigns individually to see why.

There is no matching resume-all. Resume each campaign with Resume campaign, which re-checks billing per campaign.

<Warning>A 409 means the change may or may not have been applied. The request to Google Ads timed out after it was sent. Read the campaign back with Get campaign before retrying, or you can end up applying it twice.</Warning>

<Note>This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.</Note>

<Warning>The response includes fields beyond the ones documented here. Don't rely on undocumented response fields, as they can change at any time.</Warning>

post/api/apps/{app_id}/google-ads/campaigns/pause-all

Path parameters

app_idstring required

ID of the app whose Google Ads campaigns to manage.

ID of the app whose Google Ads campaigns to manage.

Response

Successful Response

statusstring required

Outcome of the request. A status of paused means every campaign paused, and partial means at least one did not.

paused_countinteger required

How many campaigns this call paused.

total_countinteger required

How many campaigns it tried to pause.

failed_countinteger required

How many could not be paused. Retry the call, or pause those campaigns individually to see why.

Example response

{
  "status": "paused",
  "paused_count": 3,
  "total_count": 3
}

Changes

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