POST
https://api.nexscope.ai/amazonAds/authorizeUrlRun 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/authorizeUrl |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
region | string | required | Amazon Ads region. Example: NA |
marketplaceId | string | required | Amazon marketplace identifier for the Ads connection. Example: ATVPDKIKX0DER |
workspaceId | string | required | A Nexscope workspace accessible to the authenticated user. |
accountName | string | optional | Display name for the authorized account. |
Code example
{
"accountName": "My US advertising account"
}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 (2 fields)
| Name | Type | Required | Description |
|---|---|---|---|
authorizeUrl | string | optional | Amazon Ads OAuth authorization URL. |
sourceType | string | optional | Authorization source identifier, fixed to `amazon_ads`. |
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.