ADadexad

Pause Google Ads campaign

Changed on

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

Stops a campaign serving. It keeps its settings and its history, and Resume campaign starts it again.

Pausing takes effect within a few minutes on Google's side. Spend already incurred today is still billed. Pausing an already-paused campaign succeeds and changes nothing.

Unlike resuming, this needs no payment method on file, because it only reduces spend.

<Note>This endpoint accepts a personal API key or a workspace API key. A workspace API key acts as the workspace owner.</Note>

<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>

<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/{campaign_id}/pause

Request

Path parameters

app_idstring required

ID of the app whose Google Ads campaigns to manage.

campaign_idstring required

Base44's ID for the campaign, as returned in id by List campaigns. This is not the Google Ads campaign ID, which is reported separately as google_campaign_id.

Response

Successful Response

statusstring required

The action that was applied: paused, resumed, or deleted.

Example response

{
  "status": "paused"
}

Changes

  • e51af2957a57Revision changes
    • info

      added the non-success response with the status

  • 0ca6a43fceb9Revision changes
    • info

      the endpoint scheme security WorkspaceApiKeyAuth was added to the API

    • info

      the endpoint scheme security WorkspaceApiKeyBearerAuth was added to the API