Company Digital Footprint

Updates the status of a domain.

Update the status of the domain. <br/> It's not possible to update the status of the main domains, which also includes any domains provided by the user to initiate the scan or manually added later on.

patch/api/v2/companies/{id}/domains

Request

Base URL
https://app.blackkitetech.com
Auth
OAuth 2
Client credentials
Token URLhttps://app.blackkitetech.com//api/v2/oauth/token
TypeScript
https://skmtc.dev/blackkitetech/apis/black-kite-api/docs/api/v2/companies/:id/domains/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Example:123

The id of the company to be updated.

Request body

Domainstring required

The domain to be updated.

Status'Active' | 'Inactive'

The new status of the domain. Inactive domains are excluded from the risk score calculations.

Example request

{
  "Domain": "acmeinc.com",
  "Status": "Inactive"
}

Response

Success

Changes

No recorded changes to this operation across all 8 revisions of this API.