Skip to main content
POST
python

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-notte-request-origin
string | null
x-notte-sdk-version
string | null

Body

application/json
type
string
required
Allowed value: "by_domain"
domain
string
required
Minimum string length: 3
timeoutOpts
BrandTimeout · object | null
tags
string[]
Maximum array length: 20
Required string length: 1 - 50
force_language
enum<string> | null
Available options:
afrikaans,
albanian,
amharic,
arabic,
armenian,
assamese,
aymara,
azeri,
basque,
belarusian,
bengali,
bosnian,
bulgarian,
burmese,
cantonese,
catalan,
cebuano,
chinese,
corsican,
croatian,
czech,
danish,
dutch,
english,
esperanto,
estonian,
farsi,
fijian,
finnish,
french,
galician,
georgian,
german,
greek,
guarani,
gujarati,
haitian-creole,
hausa,
hawaiian,
hebrew,
hindi,
hmong,
hungarian,
icelandic,
igbo,
indonesian,
irish,
italian,
japanese,
javanese,
kannada,
kazakh,
khmer,
kinyarwanda,
korean,
kurdish,
kyrgyz,
lao,
latin,
latvian,
lingala,
lithuanian,
luxembourgish,
macedonian,
malagasy,
malay,
malayalam,
maltese,
maori,
marathi,
mongolian,
nepali,
norwegian,
odia,
oromo,
pashto,
pidgin,
polish,
portuguese,
punjabi,
quechua,
romanian,
russian,
samoan,
scottish-gaelic,
serbian,
sesotho,
shona,
sindhi,
sinhala,
slovak,
slovene,
somali,
spanish,
sundanese,
swahili,
swedish,
tagalog,
tajik,
tamil,
tatar,
telugu,
thai,
tibetan,
tigrinya,
tongan,
tswana,
turkish,
turkmen,
ukrainian,
urdu,
uyghur,
uzbek,
vietnamese,
welsh,
wolof,
xhosa,
yiddish,
yoruba,
zulu
maxSpeed
boolean
default:false
maxAgeMs
integer
default:7776000000

Response

Successful Response

brand
BrandProfile · object | null
required
status
string
default:ok
Allowed value: "ok"
code
integer
default:200
cache_metadata
BrandCacheMetadata · object
request_id
string
partial
boolean
default:false
key_metadata
BrandKeyMetadata · object | null