Skip to main content
POST
Create an API key

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.

Body

application/json
type
enum<string>
default:user

Who the key belongs to.

Available options:
user,
team,
organization
name
string

A name to tell the key apart.

Maximum string length: 100
scopes
string[]

Exact scope values, such as contacts:read.

expiresAt
string<date-time> | null

When the key stops working, which cannot change later. It must be in the future; leave it out and the key never expires. An API key that has an expiry must set this, no later than its own.

Response

The key was created.

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.

key
string
required

The API key. It appears in this response only.

name
string | null

The key's name.

expiresAt
string<date-time> | null

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