Skip to main content
POST

Authorizations

x-api-key
string
header
required

Body

application/json
apikey
string

Podřízený API klíč, který se má upravit místo volajícího klíče. Smí jej použít pouze nadřazený klíč a cíl mu musí patřit.

default_callback_url
string | null

Výchozí webhook URL pro notifikace o doručení. null nebo prázdný řetězec hodnotu smaže.

note
string | null

Vaše poznámka ke klíči. null nebo prázdný řetězec hodnotu smaže.

default_sender
string | null

Výchozí odesílatel pro zprávy, které neuvádějí sender. Může jít o zaregistrovaného odesílatele nebo o název aliasu odesílatele. Nesmí obsahovat , ani :. null nebo prázdný řetězec jej smaže. Odesílatele, který pro klíč není zaregistrovaný, uložíme, ale vrátíme jej ve warning a při odeslání bude ignorován.

Maximum string length: 64
whitelist_ip
string[] | null

IP whitelist pro odesílání. Položka obsahující . nebo : se porovnává jako přesná IP adresa (bez CIDR rozsahů); jakákoli jiná položka se porovnává jako podřetězec názvu ISP/organizace IP adresy požadavku. Zprávy odeslané z adresy mimo whitelist se místo odeslání podrží na ruční schválení. null nebo prázdné pole omezení zruší. Položky nesmí obsahovat ,.

Maximum array length: 50
Maximum string length: 100
scope
enum<string>

Nový rozsah oprávnění podřízeného klíče. Přijímáno pouze společně s apikey.

Available options:
full,
rest-api,
api
disable
enum<integer>

1 podřízený klíč zablokuje, 0 odblokuje. Přijímáno pouze společně s apikey.

Available options:
0,
1

Response

API klíč upraven

success
boolean
warning
string

Vyplněno, když se nastavení uložilo, ale něco vyžaduje pozornost, například nedostupná callback URL nebo nezaregistrovaný výchozí odesílatel.