POST
https://api.nexscope.ai/amazonAds/sb/budgetRulesRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/amazonAds/sb/budgetRules |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
connectionId | integer | required | An Amazon Ads connection owned by the authenticated Nexscope user. |
fetchAll | boolean | optional | Automatic page turning; SP and SB V4 main resource lists use `nextToken`, SB Target/BudgetRule uses `nextToken` (BudgetRule query must contain `pageSize`), SB Keyword GET, SB V3 GET and SD use `startIndex + count`. Example: true |
maxResults | integer | optional | Single page 1–100; SD corresponds to count. Example: 100 |
skipDepCheck | boolean | optional | Skip dependency checking. Example: false |
includeExtendedDataFields | boolean | optional | Some entities return extended fields; SD is switched through the /extended path. |
locale | string | optional | Localization parameters (supported by some keyword scripts). |
method | string | required | Upstream HTTP methods: `GET` for list, `POST/PUT` for create/modify. |
body | string | optional | Create/modify must provide payload; list uses queryString. |
contentType | string | optional | Create/modify using `application/json`; GET list does not send Content-Type. |
accept | string | optional | `application/json`。 |
pageSize | integer | optional | SB V4 Budget Rule GET list number per page, range 1–100; list pagination also uses `nextToken`. Example: 100 |
queryString | string | optional | Pass upstream query parameters when needed. |
confirmationToken | string | optional | For mutations, first preview without a token, then confirm using the returned single-use token. |
Code example
{
"accept": "application/json",
"body": "{}",
"contentType": "application/json",
"method": "POST"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
Response field reference (10 fields)
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | optional | Whether the API completed the call successfully. |
apiVersion | string | optional | `V3` or `V4` (if provided by the script). |
amazonResourceVersion | string | optional | The actual Amazon resource version (if provided by the script). |
budgetRules | array | optional | Array of Sponsored Brands Budget Rules; actual fields returned by Amazon. |
budgetRulesForAdvertiserResponse | array | optional | Raw list fields that may be returned by Amazon GET list; API normalizes them to `budgetRules`. |
total | integer | optional | The number of aggregated entries (if provided by the script). |
pagesFetched | integer | optional | Number of pages obtained. |
truncated | boolean | optional | Whether it was truncated due to paging limit. |
name | string | optional | Name (returned if supported by the entity). |
state | string | optional | `ENABLED`, `PAUSED` or `ARCHIVED` (SD upstream may use lowercase). |
Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.