Sign in

v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB
Utility

Prefetch brand data by email

Signal that you may fetch brand data for a particular domain soon to improve latency. This endpoint accepts an email address, extracts the domain from it, validates that it's not a disposable or free email provider, and queues the domain for prefetching.

post/brand/prefetch-by-email

Request body

emailstring email required

Email address to prefetch brand data for. The domain will be extracted from the email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email addresses are not allowed.

timeoutMSinteger

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Example request

{
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

Successful response

statusstring

Status of the response, e.g., 'ok'

messagestring

Success message

domainstring

The domain that was queued for prefetching