Skip to navigation
BotBye APIAnti-PhishingProject Domains

update domain status

View as Markdown

Update the status of a single domain record.

The record ends up WHITELISTED, whatever status is sent. MIRROR is deprecated and kept only for existing integrations: setting it also makes the record’s host the project’s domain, exactly as if the project were updated with it; the project’s previous domain stays on as a WHITELISTED record.

Accepted permissions Account → Phishing Projects → Update

Token scope Account Phishing Projects Action

Authentication

X-Api-Keystring

Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header. A token works only for the account it was created in.

Path parameters

account_idstringRequired
project_idstringRequired
domain_record_idstringRequired

Request

This endpoint expects an object.
statusenumRequired

WHITELISTED. MIRROR is deprecated: the record is still stored WHITELISTED, and its host becomes the project’s domain.

Allowed values:

Response

success