Update a marketing message campaign

Update a marketing message campaign — rename it, pause / reactivate it, change its budget, or rename its ad / ad set. At least one of `name` / `status` / a budget field is required.

patch/campaigns/{campaignId}

Beta

The External API is in beta. Endpoints, parameters, and response shapes may change — including breaking changes — in future releases. Pin to documented behavior before relying on it in production.

Authorization

x-api-key x-date x-signature x-api-version

x-api-key<token>

Your API key (the ApiKeys document id).

In: header

x-date<token>

Current timestamp as an IMF-fixdate string (GMT, US locale) "EEE, dd MMM yyyy HH:mm:ss z", e.g. "Sun, 06 Dec 2020 12:59:11 GMT". 30-second TTL.

In: header

x-signature<token>

HMAC-SHA256 of the x-date string keyed by your secret, lowercase hex.

In: header

x-api-version<token>

API version you're coding against — currently 1. Required; a missing or unsupported value returns 400 with Missing or unsupported x-api-version header. Supported versions: 1.

In: header

Path Parameters

campaignId*string

The Meta campaign id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update a marketing message campaign. At least one of name / status / a budget field is required; at most one budget field, and a budget change also requires adsetId.

name?string

Rename the campaign.

status?string

Pause or reactivate the campaign. PROCESSING / EXPIRED are derived states and can't be set.

dailyBudget?string

New daily budget (digit-string, minor currency units). Requires adsetId.

lifetimeBudget?string

New lifetime budget (digit-string, minor currency units). Requires adsetId.

adsetId?string

The list item's adset.id — required with a budget change (budgets live on the ad set).

adName?string

Rename the ad (applied alongside the campaign update).

adsetName?string

Rename the ad set (applied alongside the campaign update).

Response Body

`application/json`

Try it

live — writes real data

Kept in this tab only and signed in your browser — your secret never leaves your device.

Path

campaignId*The Meta campaign id.

Body

nameRename the campaign.statusPause or reactivate the campaign. `PROCESSING` / `EXPIRED` are derived states and can't be set.dailyBudgetNew daily budget (digit-string, minor currency units). Requires `adsetId`.lifetimeBudgetNew lifetime budget (digit-string, minor currency units). Requires `adsetId`.adsetIdThe list item's `adset.id` — required with a budget change (budgets live on the ad set).adNameRename the ad (applied alongside the campaign update).adsetNameRename the ad set (applied alongside the campaign update).

This sends a real PATCH to your live organization.

Enter your key and secret to send.

curl -X PATCH "https://example.com/campaigns/120210000000000000" \  -H "Content-Type: application/json" \  -d '{    "name": "Renamed campaign",    "status": "PAUSED",    "lifetimeBudget": "80000",    "adsetId": "120210000000000001"  }'

{  "campaign": {    "success": true  },  "adset": {    "success": true  }}

{  "message": "string"}

{  "message": "string"}

{  "message": "string"}

{  "error": [    {      "message": "string",      "path": [        "string"      ],      "type": "string",      "context": {}    }  ]}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

402application/json

403application/json

422application/json

Try it

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`