create domains | Botbye | Documentation

Add one or more phishing-protected domain records to a project.

Domains the project already has are skipped: the response returns the ids of the newly created records only, in request order — an empty array when every domain was already present.

A MIRROR record extends the brand BotBye protects, so it requires the project to have proven that it controls one of its own domains: the verification token is published either as a DNS TXT record on the registrable domain or as a <meta> tag on its home page. Ownership is proven from your BotBye account — the API carries no endpoint for it. Until that proof is on file a request carrying any MIRROR record answers 403 protection_phishing_domain_verification.project_domain_not_verified; a batch of WHITELISTED records only is unaffected.

Accepted permissions Account → Phishing Projects → Create

Token scope Account Phishing Projects Action

Add one or more phishing-protected domain records to a project. Domains the project already has are skipped: the response returns the ids of the newly created records only, in request order — an empty array when every domain was already present. A `MIRROR` record extends the brand BotBye protects, so it requires the project to have proven that it controls one of its own domains: the verification token is published either as a DNS `TXT` record on the registrable domain or as a `<meta>` tag on its home page. Ownership is proven from your BotBye account — the API carries no endpoint for it. Until that proof is on file a request carrying any `MIRROR` record answers `403` `protection_phishing_domain_verification.project_domain_not_verified`; a batch of `WHITELISTED` records only is unaffected. > **Accepted permissions** > `Account → Phishing Projects → Create` > > **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.

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

Request

This endpoint expects a list of objects.

domainstringRequired

notestring or nullOptional

statusenumOptional

Response

success

Add one or more phishing-protected domain records to a project.

Domains the project already has are skipped: the response returns the ids of the newly created records only, in request order — an empty array when every domain was already present.

Accepted permissions Account → Phishing Projects → Create

Token scope Account Phishing Projects Action