Change its settings (Market Radar API)

Its name, schedule, subject, review and hold back; what is not sent stays. All or nothing. Review needs a reviewer, a member named by email. Live is turned on and off in the app: a body with live fails.

Authorization

key

AuthorizationBearer <token>

A key created in the app under Settings, API and MCP. Read keys read; Read and write keys also add, edit and delete companies, custom sources, groups and radars, and create, rename and delete folders.

In: header

Path Parameters

id*integer

Range0 < value <= 9007199254740991

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length

schedule?

subject_pattern?string

Value in

"issue"
"date"
"issue_date"

review?boolean

reviewer?|

A member's email; null for none

hold_back?boolean

Response Body

`application/json`

curl -X PATCH "https://example.com/newsletters/1" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": 1,  "name": "string",  "live": true,  "schedule": {    "cadence": "weekly",    "weekday": 1,    "time": "string",    "time_zone": "string"  },  "subject_pattern": "issue",  "review": true,  "reviewer": {    "email": "string",    "name": "string"  },  "hold_back": true,  "recipients": -9007199254740991,  "radar_ids": [    1  ],  "next_send_at": "2019-08-24T14:15:22Z",  "template_version": "string"}

Change its settings

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`