Update an Ad
Updates an ad in an ad group.
URL
PUT https://api.searchads.apple.com/api/v5/campaigns/{campaignId}/adgroups/{adgroupId}/ads/{adId}Path Parameters
| Name | Type | Description |
|---|---|---|
adId Required | int64 | A unique identifier representing the assignment relationship between an ad group and an Ad. |
adgroupId Required | int64 | The unique identifier for the ad group. |
campaignId Required | int64 | The unique identifier for the campaign. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AdResponse | If the call succeeds, the API returns the AdResponse object 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 or replace an Ad. Use your adId in the resource path. The follow-up step is to create an Ad using your creativeId. See Create an Ad. You can assign one active custom product page to an ad group. For information about how to edit a subset of object properties without having to include all object properties in the payload, see the Use Partial Updates section in Using Apple Ads API Functionality.
Payload example: Update an ad
HTTP Body
The request body that includes the details of the Creative.