Set the firm's configuration controls Run in API Explorer
Ask AI
Enables or disables sub-firm and/or adviser configuration for a setting. Disabling sub-firm configuration removes the value it allowed the firms below it to hold, with an audit entry and an in-app notice to each affected firm's admins.
PUT
/api/v1/firm/{firm_uuid}/network-settings/{key}/configuration-controls
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/firm/6ff8f7f6-1eb3-3525-be4a-3932c805afed/network-settings/mandatory_firm_two_factor/configuration-controls' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"sub_firm_configuration_enabled": true,
"adviser_configuration_enabled": true
}'
Request examples
{
"sub_firm_configuration_enabled": true,
"adviser_configuration_enabled": true
}
Response examples (200)
[
{
"key": "mandatory_firm_two_factor",
"label": "Mandatory firm 2FA",
"sub_firm_configuration_enabled": false,
"adviser_configuration_enabled": false,
"editable": true,
"locked_message": "Mandatory firm 2FA is mandated by Network and cannot be changed for your firm."
}
]
Response examples (422)
{
"message": "The given data was invalid.",
"errors": {
"field": [
"The field is invalid."
]
}
}