Set the firm's configuration controls Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

Close
PUT /api/v1/firm/{firm_uuid}/network-settings/{key}/configuration-controls

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.

Path parameters

  • firm_uuid string Required
  • key string Required
application/json

Body

  • sub_firm_configuration_enabled boolean

    whether the firm's direct sub-firms can hold their own value for this setting

  • adviser_configuration_enabled boolean

    whether the firm's advisers can hold their own value for this setting

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • key string
    • label string
    • sub_firm_configuration_enabled boolean
    • adviser_configuration_enabled boolean
    • editable boolean
    • locked_message string
  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
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."
    ]
  }
}