Skip to main content
POST
Send a dashboard invite

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Scopes

connected_accounts:write

Path Parameters

account_id
string
required

The account to act on. It must be one of your own accounts.

Response

Invite sent.

dashboard
enum<string>
required

The account's access mode. Always full here.

Available options:
full
dashboard_access
enum<string>
required

invited once the invite is out.

Available options:
invited,
active