---
title: "Submit settings requests"
method: POST
path: "/settings/batch-requests"
tags: ["Settings"]
---

# Submit settings requests

`POST /settings/batch-requests`

Submit a batch of settings requests by this single API operation.

See a [200 response sample in CSV format](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.csv) that lists all available settings. 

See a [200 response sample in JSON format](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.json) that lists all available parameters of each setting.

By default, one batch settings request can contain a maximum of 100 single operation requests, including: 
* All the single requests in the process batch settings request.
* All the children requests of the single requests.

This maximum value is configurable.

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Request body

- SettingsBatchRequest
  - `requests` SettingValueRequest[]
    - `body` BodyInSettingValueRequest — Request payload if any
    - `children` ChildrenSettingValueRequest[] — An array of requests that can only be executed after its parent request has been executed successfully.
      - `body` BodyInSettingValueRequest — Request payload if any
      - `id` string — The id of the request. You can set it to any string. It must be unique within the whole batch.
      - `method` 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'TRACE' — One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE.
      - `url` string — The relative URL of the setting. It is the same as in the `pathPattern` field in the response body of [Listing all settings](https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings). For example, `/billing-rules`.
    - `id` string — The id of the request. You can set it to any string. It must be unique within the whole batch.
    - `method` 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'TRACE' — One of the HTTP methods supported by the setting endpoint, for example, GET,PUT,POST or DELETE.
    - `url` string — The relative URL of the setting. It is the same as in the `pathPattern` field in the response body of [Listing all Settings](https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings). For example, `/billing-rules`.

## Response `200`

OK

- SettingsBatchResponse
  - `responses` SettingValueResponseWrapper[]
    - `id` string — The Id of the corresponding request.
    - `method` 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'TRACE' — The HTTP method. It is the same as that of the corresponding request.
    - `response` SettingValueResponse
      - `body` BodyInSettingValueReponse — Response body if the request is executed successfully.
      - `errorMessages` string[] — An array of error messages if errors occur when executing the request.
      - `status` string — User readable response status, for example, 502 BAD_GATEWAY.
    - `url` string — The url as specified in the corresponding request.

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)