Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

POST: Bulk Unsubscribe

Avatar
Ingrid
Follow
Publication Date – March 29, 2022

⇤ Subscriptions

https://api.bitsighttech.com/ratings/v1/subscriptions/bulk

Unsubscribe from multiple companies in your portfolio.

Parameters

*Required.

Parameter Description Values 
delete
Body		 Companies to unsubscribe from. [Array] Objects containing company details.
  
guid
Body		 Identify companies to unsubscribe from. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

Example Request

cURL:

curl 'https://api.bitsighttech.com/ratings/v1/subscriptions/bulk'
-H 'Content-Type: application/json'
--data-binary '{
  "delete": [
    {
      "guid": "a5e23bf0-38d4-4cea-aa50-19ee75da481d",
    }
  ]
}'
--compressed
-u api_token:

JSON:

{
  "delete": [
    {
      "guid": "a5e23bf0-38d4-4cea-aa50-19ee75da481d",
    }
  ]
}

Example Response

{
  "added": [],
  "modified": [],
  "deleted": [
    {
      "guid": "a5e23bf0-38d4-4cea-aa50-19ee75da481d"
    },
  ],
  "error": [
    {
      "guid": "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
      "message": "insufficient-permissions"
    }
  ]
}

Response Attributes

Field Description 
added
Array		 New subscriptions. 
modified
Array		 Modified subscriptions. 
deleted
Array		 Removed subscriptions.
  Object A deleted subscription.
  
guid
String [entity_guid]		 The unique identifier of this unsubscribed company. 
error
Array		 Request errors.
  Object A request error.
  
guid
String [entity_guid]		 The unique identifier of this company. 
message
String		 The error summary.

Status Codes

See common errors and status codes.

Code Description
200 – OK Everything worked as expected.
403 – Unauthorized You do not have subscription permissions.

Related articles