Skip to main content
PATCH
Change the firm

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Body

application/json
name
string | null
Maximum string length: 200
brand_color
string · null · null
Maximum string length: 20
logo
string · null · null
Maximum string length: 1500000
send_client_emails
boolean | null
show_secured_by
boolean | null

Response

Success.

object
enum<string>
required
Available options:
organisation
id
string
required
name
string
required
slug
string
required
brand_color
string | null
required

A colour as #RRGGBB.

Whether a logo is set. The image is not returned.

send_client_emails
boolean
required

Whether Advisor emails clients. Off, the firm sends its own from webhooks.

show_secured_by
boolean
required

Whether the portal footer says Secured by Redbark.

onboarded
boolean
required
acting_as
object
required