Skip to main content
POST
/
brokerage-firms
/
{brokerageFirmId}
/
brokers
Create broker
curl --request POST \
  --url https://api.example.com/brokerage-firms/{brokerageFirmId}/brokers \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "brokerUserId": "<string>",
  "brokerRole": "<string>"
}
'
{}

Path Parameters

brokerageFirmId
string
required

Brokerage firm id

Body

application/json

Broker payload including the target user id and optional profile/role fields

firstName
string
required

First name

lastName
string
required

Last name

brokerUserId
string
required

User id

brokerRole
string

Response

Broker created successfully.

The response is of type object.