Skip to main content
POST
Prefetch data
0 Credits Only for Subscribers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <API_KEY>. Keys have full access by default.

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.

timeoutOpts
object

Optional request deadline and behavior on timeout. For GET requests, use timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded timeoutOpts object.

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

request_id
string<uuid>
required

Unique id of this API call, also sent in the X-Request-Id response header. Quote it when contacting support about a failed request.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

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

Credit usage, included whenever a valid API key is provided.