---
title: "Update firm client-onboarding settings"
method: PATCH
path: "/client-onboarding/configuration"
tags: ["Client Onboarding"]
---

# Update firm client-onboarding settings

`PATCH /client-onboarding/configuration`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/client-onboarding/configuration`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

Updates the default onboarding contact, public contact details, selected firm Stripe integration, standard question settings, or up to ten custom questions. Requires Firm Owner or Admin access.

## Request body

- ClientOnboardingConfigurationPatch
  - `defaultOnboardingMemberId` string, uuid, nullable
  - `stripeIntegrationId` string, uuid, nullable
  - `publicContactTitle` string, nullable
  - `publicContactPhone` string, nullable
  - `standardQuestionSettings` object
  - `customQuestions` ClientOnboardingCustomQuestion[]
    - `id` string, uuid, required
    - `prompt` string, required
    - `type` 'short_text' | 'long_text' | 'yes_no' | 'single_select', required
    - `required` boolean, required
    - `options` string[], required
    - `order` integer, required

## Response `200`

Updated firm client-onboarding configuration

- ClientOnboardingConfigurationResponse
  - `configuration` object, required
    - `firmOrganizationId` string, uuid, required
    - `firmSlug` string, required
    - `defaultOnboardingMemberId` string, uuid, nullable, required
    - `stripeIntegrationId` string, uuid, nullable, required
    - `publicContactTitle` string, nullable
    - `publicContactPhone` string, nullable
    - `packages` object[], required
    - `standardQuestions` object[], required
    - `customQuestions` ClientOnboardingCustomQuestion[], required
      - `id` string, uuid, required
      - `prompt` string, required
      - `type` 'short_text' | 'long_text' | 'yes_no' | 'single_select', required
      - `required` boolean, required
      - `options` string[], required
      - `order` integer, required
    - `loeDraft` object, required
      - `document` ClientOnboardingLoeDocument
        - `type` 'doc', required
        - `content` ClientOnboardingLoeNode[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
      - `contentHash` string
      - `updatedAt` string, date-time, nullable
    - `publishedLoe` object, nullable, required
    - `availableOnboardingContacts` object[], required
    - `stripeReadiness` object, required
    - `branding` object, required
    - `readiness` object, required
    - `capabilities` object, required
      - `canManageConfiguration` boolean, required
      - `canManagePackages` boolean, required
      - `canPublishEngagementLetter` boolean, required
      - `canManageBranding` boolean, required

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/01c3e57d281f?raw)