Skip to content
Sign in Sign up

Request a country

POSTapi.baseray.ai/v1/public/country-requests

Asks for baseray in a country it does not cover yet, for a person who agrees to be emailed when it does. One request per address and country: asking again changes nothing and answers the same, so the answer never tells whether an address had asked before. A country baseray already covers answers live and stores nothing. The address is never shown or shared; product analytics count the country only.

Request body

countrystringrequired
The country asked for: an ISO 3166-1 alpha-2 code, such as DE.
emailstring (email)required
Where to write when baseray covers the country. Compared in lower case: the same address asks for a country once.
consenttruerequired
Must be true: the person agrees to be emailed about this country. Kept for 24 months at most and deleted on request (privacy@baseray.ai).
companystring or null
The person's company, up to 200 characters.
use_casesolar_prospecting | heating_upgrades | energy_efficiency | insurance_underwriting | real_estate_prospecting | market_research | other or null
What they want the buildings for.
localestring or null
The language to write back in, as a two-letter code (en, ro, cs).
attributionobject or null
Where the person came from before asking (first touch), as the website carries it.
utm_sourcestring or null
Campaign source, up to 200 characters.
utm_mediumstring or null
Campaign medium, up to 200 characters.
utm_campaignstring or null
Campaign name, up to 200 characters.
utm_contentstring or null
Campaign content, up to 200 characters.
utm_termstring or null
Campaign term, up to 200 characters.
gclidstring or null
Google Ads click id, up to 200 characters.
referrer_hoststring or null
Host of the site that sent the person, up to 255 characters.
landing_pathstring or null
The first page the person saw, up to 500 characters.

Response 200

baseray already covers this country; nothing was stored.

statusreceived | liverequired
received: the request is on the list (also when this address had asked before). live: baseray already covers the country; nothing was stored.
countrystringrequired
The country asked for, upper case.

Errors

400
A field is missing, malformed or unknown (invalid_parameter); parameter names it.
429
Too many country requests from this visitor in an hour (rate_limited); retry after Retry-After seconds.

Every error has the same shape. Error codes.