Skip to main content
POST
JavaScript
0 Credits Only for Subscribers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>, where <API_KEY> is your api key.

Body

application/json
type
enum<string>
required

What to prefetch: 'brand' warms the brand data cache, 'styleguide' warms the styleguide cache.

Available options:
brand,
styleguide
identifier
By domain · object
required

Identifier of the target to prefetch. Provide exactly one of domain or email.

timeoutMS
integer

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).

Required range: 1000 <= x <= 300000
tags
string[]

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

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

status
string

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

message
string

Success message

type
enum<string>

The type of prefetch that was queued, echoed from the request

Available options:
brand,
styleguide
domain
string

The domain that was queued for prefetching

key_metadata
object

Metadata about the API key used for the request. Included in every response whenever a valid API key is provided, even when the response status is not 200.