Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

POST: Bulk Subscribe

Avatar
Ingrid
Follow
Publication Date – March 21, 2022

⇤ Subscriptions

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

Subscribe to up to 1000 companies.

Parameters

*Required.

Parameter Description Values 
add
Body		 Companies to subscribe to. [Array] Objects containing company details.
  
guid
Body		 Identify the company by unique identifier. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details. 
folder
Body		 Specify one or multiple folders for the company. [Array] Comma-separated folder names. See GET: Folder Details. 
tier
Body		 Specify a tier for the company. [String] Tier name. See GET: Tiers. 
type
Body		 Specify a subscription to use. [String] Subscription slug name. See subscription types.

Example Request

cURL:

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

JSON:

{
  "add": [
    {
      "guid": "a5e23bf0-38d4-4cea-aa50-19ee75da481d", 
      "folder": ["my_folder", "my_other_folder"],
      "tier": "tier_1",
      "type": "continuous_monitoring"
    }
  ]
}

Example Response

{
  "added": [
      "a5e23bf0-38d4-4cea-aa50-19ee75da481d",
  ],
  "modified": [
    "feeccea4-e062-4cf5-9a3d-7034addb12d1",
  ],
  "errors": [
    {
      "guid": "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
      "message": "Error message."
    }
  ]
}

Response Attributes

Field Description 
added
Array [entity_guid]		 Companies that were subscribed to. 
modified
Array [entity_guid]		 Companies that were switched. 
errors
Array		 Unsuccessful subscription modifications.
  
guid
String [entity_guid]		 The unique identifier of this company. 
message
String

The reason for the error.

Payload Validation Related Error Messages:

  • Too many companies in request
  • Multiple requests for the same company
  • No matching company found
  • Invalid company subscription type {subscription_type}
  • Could not resolve folder name {folder_name}
  • Could not resolve tier name {tier_name}

Subscription Related Error Messages:

  • Company trying to subscribe to is not a subsidiary and cannot be subscribed to under {subscription_type}
  • The number of companies requested exceeds your available quota for {subscription_type}
  • Company already exists in {subscription_type} subscription
  • You are not allowed to subscribe constituents
  • You are not allowed to subscribe {entity_guid} as a constituent
  • Cannot add a partner provided company to the portfolio
  • Current subscription type does not allow upgrade to {subscription_type}

Status Codes

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

Related articles