CentralCSP
APIUsage

Set workspace usage-alert recipients

Replaces the recipient list. Send an empty array to turn workspace usage emails off. Every id must belong to a member of this workspace.

Requires the admin role on the workspace.

PUT
/v1/workspaces/{workspaceId}/usage-alerts/recipients

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

Request Body

application/json
  1. body

The full recipient list.

memberIds*array<>

The id of each membership to email, up to 200. Send an empty array to turn these emails off.

Itemsitems <= 200

Response Body

Who is emailed as usage approaches the limit.

application/json
  1. response
recipients*array<>

Members on the list. An empty array means nobody is emailed.

Example Request
curl -X PUT 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/usage-alerts/recipients' \  -H 'Content-Type: application/json' \  -d '{  "memberIds": [    "string"  ]}'
Example Response
{  "recipients": [    {      "memberId": "string",      "hasAccess": true,      "email": "string",      "firstName": "string",      "lastName": "string"    }  ]}