Skip to main content
PATCH
Update 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.

Path Parameters

brokerUserId
string
required

Broker user id

brokerageFirmId
string
required

Brokerage firm id

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

Body

application/json

Fields to update for the broker

firstName
string

First name

lastName
string

Last name

brokerRole
string

Response

Broker updated successfully.

The response is of type object.