Skip to main content
POST
Invite a broker

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Body

application/json
email
string<email>
required

Email address to invite

brokerageFirmId
string
required

Brokerage firm id

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
firstName
string
required

First name

lastName
string
required

Last name

brokerRole
string

Broker role

Response

The response is of type object.