Market Radar API
API referenceFolders

Rename a folder

A new name, as Rename in the app does. Its radars stay in it, and name it anew. Another folder's name, whatever its case, fails with conflict; the folder's own name in another case is saved.

PATCH
/folders/{id}

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.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/folders/1" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "id": 1,  "name": "string",  "radar_ids": [    1  ],  "created_at": "2019-08-24T14:15:22Z"}

Create a folder POST

An empty folder, as Create folder in the app does. Put a radar in it with POST /radars and its id as folder_id, or move one in with PATCH /radars/{id}. A name the account already has, whatever its case, fails with conflict. No plan limits folders.

Delete a folder and its radars DELETE

As in the app, its radars are deleted with it, each as DELETE /radars/{id} would: their sweeps, signals and sources, or a tender radar's calls, go too, and each radar leaves the newsletters that used it. Companies, custom sources, groups and filters stay. To keep a radar, move it to another folder first with PATCH /radars/{id} and folder_id.