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

# ResponseEnvelope

The standard response envelope for all Recommendations and Suggestions API endpoints.

```
object RecommendationResponseBody
```

## Discussion

The response envelope is the standard wrapper returned by all Recommendations and Suggestions endpoints.

The `result` field contains the response payload. It’s usually an array, but for the Target CPA suggestion query response ([`RecommendationQueryTargetCpaSuggestionResponse`](/documentation/Apple-Ads-Platform-API/RecommendationQueryTargetCpaSuggestionResponse)) specifically, it’s a single object, since that endpoint always returns one suggestion rather than a list.

The `pagination` field describes the current page position and is `null` for apply and dismiss responses.

### Example

```json
{
  "result": [
    {
      "id": "rec-budget-001",
      "recommendationType": "DAILYCAP",
      "campaignId": 789012,
      "state": "AVAILABLE"
    }
  ],
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}
```

## Topics

### Dictionaries

[`object RecommendationResponseBody.Result`](/documentation/Apple-Ads-Platform-API/RecommendationResponseBody/Result-data.dictionary)

Usually an array of recommendation, suggestion, or history objects returned by the endpoint. A single object for the Target CPA suggestion query response.

---

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)