Market Radar API
API referenceGroups

Rename a group or change its members

A name, member_ids, or both; member_ids replaces the whole list ([] empties the group), and a company or custom source taken out stays in the account. Its kind never changes. Every radar following the group searches its members as they are from its next sweep; no sweep starts. A member that would take a radar following the group past its limit (50 companies and filters in a query, 30 custom sources) fails on member_ids, naming the radar, and changes nothing.

PATCH
/groups/{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/groups/1" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": 1,  "name": "string",  "kind": "companies",  "member_ids": [    1  ],  "radar_ids": [    1  ],  "created_at": "2019-08-24T14:15:22Z"}

One group GET

Previous Page

Delete a group and its members DELETE

As in the app, its members are deleted with it, each as DELETE /companies/{id} or DELETE /custom-sources/{id} would, so a member leaves its other groups too; every radar that followed the group or searched a member stops searching them. To delete the group alone, set its member_ids to [] first. The signals already found stay. No sweep starts.