Update a Campaign
Updates a campaign with a campaign identifier.
URL
PUT https://api.searchads.apple.com/api/v5/campaigns/{campaignId}Path Parameters
| Name | Type | Description |
|---|---|---|
campaignId Required | int64 | The unique identifier for the campaign. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | CampaignResponse | If the call succeeds, the API returns the Campaign objects in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | The API can’t locate the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Mentioned in
Discussion
Use this endpoint to update countries or regions (App Store geolocations) where you promote your app, and to set your campaign budget. Use the associated campaignId as a resource.
To edit a subset of object properties without having to include all object properties in the payload, use partial updates. Use a campaign object JSON envelope in your campaign update request payloads. Other objects don’t require a JSON envelope. See the Use Partial Updates section of Using Apple Ads API Functionality.
Payload example: Switch from a manual to a Maximize Conversions bid strategy campaign
Ad group and keyword bid values are hidden (returned as 0) in Maximize Conversions campaigns. If you switch back to the manual strategy later, your bids will be restored.
The TargetCpa must be must be provided.
The campaign requires an automated ad group to run. See Create an Ad Group.
Payload example: Switch from a Maximize Conversions to a manual bid strategy campaign
Bid values on ad groups and keywords are visible in Maximize Conversions campaigns.
The TargetCpa must be set to null.
Bids will be added based on recommended bids for the campaign. If the campaign previously used a manual strategy, your previous bids will be restored. It is recommended to review all keywords and bids before running a campaign to ensure that they align with your business goals.
For reports with a Maximize Conversions bidding strategy, see campaign and ad group Get Campaign-Level Reports and Get Ad Group-Level Reports.
Payload example: Update a campaign
Payload example: Update a target CPA of a Maximize Conversions bid strategy
Payload example: Update a campaign daily budget amount
Payload example: Update a campaign with countries or regions
HTTP Body
The request body that includes the details of the campaign.