Update market

Updates a specific market by ID. Only the fields provided will be updated. Include bank_account to create and link a new payout bank account.

Path Params
string
required
Body Params
string | null
deprecated

Deprecated: use fiduciary_account_id.

bank_account
object

Bank account details. When provided, an external account is created and linked as the market's payout destination, replacing any current one.

contact_address
object

Market's mailing address

string | null

Contact email address

string | null

Contact person's name

string | null

Contact phone number

string | null

Your system's identifier for this market

string | null

Advance fiduciary account that funds this market's payouts.

global_agency_fees
array of objects | null

Agency fees (paid to the agency)

Global Agency Fees
global_policy_fees
array of objects | null

Policy fees (paid to the market)

Global Policy Fees
string | null

Display name of the market

boolean | null

Email the market when their scheduled payout is sent

boolean | null

Email the tenant's admins when a payout fails

boolean | null

Email the tenant's admins when a payout is sent

payout_cadence

Payout cadence configuration

string | null

Free-text notes added to this market's payout confirmation email. Null follows your account-level notes.

boolean | null

Enable automatic scheduled disbursements

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json