Skip to main content
PATCH
Update brokerage firm

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

brokerageFirmId
string
required

Brokerage firm id

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

Body

application/json

Fields to update in the brokerage firm

customFields
object[]

custom fields per product

customFieldsToDelete
string[]

Custom fields to delete

companyInfo
object

Partial company info to merge into the existing one (used by wholesale to override retail company info without running a SIREN lookup).

Response

Brokerage firm updated successfully.

The response is of type object.