<!--
{
  "availability" : [
    "Apple Ads Platform API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Apple-Ads-Platform-API",
  "identifier" : "/documentation/Apple-Ads-Platform-API/Error",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Apple Ads Platform API"
    ],
    "preciseIdentifier" : "data:apple-ads-platform-api:Error"
  },
  "title" : "Error"
}
-->

# Error

The standard error envelope that the API returns when a request fails.

```
object Error
```

## Discussion

The `Error` object is the standard error envelope that the API returns when a request fails.

Change History endpoints use a separate, ChangeHistory-specific error object, [`ErrorMessage`](/documentation/Apple-Ads-Platform-API/ErrorMessage), whose `code` is a closed enum (`BAD_REQUEST`, `NOT_FOUND`, `NOT_AUTHED`) rather than the open string used here.

Check `details` when you need to pinpoint exactly which part of the request was invalid, for example, a specific field value that violated a constraint or a missing required parameter.

### Example

```json
{
  "code": "INVALID_ARGUMENT",
  "message": "The request could not be processed because one or more fields failed validation.",
  "details": [
    {
      "code": "FIELD_REQUIRED",
      "message": "campaign.name is required and was not provided for AwayFinder campaign creation."
    }
  ]
}
```

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)