Company brief

Create or update a company brief section

Writes an answered standard or custom brief section. For an existing section, pass its expectedUpdatedAt value to prevent overwriting a concurrent edit.

put/companies/{companyId}/brief/sections/{sectionKey}

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/companies/{companyId}/brief/sections/{sectionKey}
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Path parameters

companyIdstring uuid required

LedgerHQ company UUID

sectionKeystring required

Stable standard or custom_ company brief section key

Request body

titlestring nullable
contentstring required
expectedUpdatedAtstring date-time nullable

Response

Saved company brief section

idstring uuid nullable
sectionKeystring required
titlestring required
questionstring nullable
guidancestring nullable
isStandardboolean required
status'unasked' | 'answered' | 'deferred' | 'not_applicable' required
contentstring nullable
source'accountant' | 'tally_interview' | 'document' | 'null' nullable
lastEditedSource'accountant' | 'tally_interview' | 'document' | 'null' nullable
updatedByUserIdstring uuid nullable
lastAskedAtstring date-time nullable
deferredUntilstring date nullable
manualOnlyboolean required
createdAtstring date-time nullable
updatedAtstring date-time nullable

Changes

No recorded changes to this operation across all 5 revisions of this API.