Skip to main content
POST
Make a client invite link

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60

Body

application/json

The body is of type object.

Response

Success.

object
enum<string>
required
Available options:
client_invite_link
client_id
string
required
url
string
required

The portal invite link. It signs the person in, works once and expires in 14 days.