Skip to main content
POST
Create a mailbox connection link

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

Request body for creating a link that connects one new mailbox.

provider
enum<string>
required

Mail provider of the mailbox to connect.

Available options:
gmail,
office365
name
string

Optional label that identifies the link in the pending list.

Maximum string length: 100

Response

Connection link created

A link that connects one mailbox. The link is returned only in this response.

URL to hand to the mailbox owner. The token is the last path segment. It opens a page that needs no Reply sign-in, connects exactly one mailbox, and works once.

pendingAccountId
integer
read-only

ID of the pending entry created for this link. Use it to revoke the link.

provider
enum<string>
read-only

Mail provider the link connects.

Available options:
gmail,
office365
expiresAtUtc
string<date-time>
read-only

UTC timestamp when the link expires, 7 days after it is created.