Skip to main content
PUT
Set an API key's scopes

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

id
integer
required

The key's id.

Body

application/json
scopes
string[]
required

The scopes the key ends with.

Response

The key as it now stands.

id
integer
required

The key's id.

type
enum<string>
required

Who the key belongs to.

Available options:
user,
team,
organization
hint
string
required

The start and end of the key, as Settings shows it.

createdAt
string<date-time>
required

When the key was created.

scopes
string[]
required

The scopes as stored, which may include wildcards set in Settings.

name
string | null

The key's name.

expiresAt
string<date-time> | null

When the key stops working, or null if it never does.