Sign inGet an API key

Update API key

Replaces the key's name, scopes and spending limit. The secret does not change, so live traffic keeps working.

PUT/api-key/{id}
AuthAPI keyorOAuth tokenHow to send it

Path parameters#

idstringrequired

The API key to update.

e.g. "ak_01KE7XWWEQ4MCGWKBQKJ1G47RP"

Request body#

scopesstring[]required
≥ 1 items
spendingLimitnumber | nullrequired
spendingLimitPeriodstring | nullrequired
"day""month""week"
namestring | null
≥ 1 characters≤ 256 characters

Response#

200API key updated

dataobjectrequired
idstringrequired
namestring | nullrequired
scopesstring[]required
spendingLimitstring | nullrequired
spendingLimitPeriodstring | nullrequired
"day""month""week"

Errors#

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.