Skip to content
Leadtime
English
Esc
navigateopen⌘Jpreview

Update organization document settings

Partially updates document formatting settings for an organization. Only the fields you provide will be updated; all other fields remain unchanged.

What are Document Settings? Document settings control how project documents (quotes, requirement documents, contracts) are formatted for this organization. These settings can override workspace defaults to enable customer-specific layouts.

Available settings:

  • projectDocumentEnableToc: Include table of contents (boolean or null to inherit)
  • projectDocumentTitlePage: Show title/cover page (boolean or null to inherit)
  • projectDocumentHeadingStyle: Heading formatting style (enum value or null to inherit)
  • projectDocumentDefaultContactUserId: Default contact person UUID (or null to clear)

Inheritance:

  • Set any field to null to inherit the workspace default for that setting
  • Provide a value to override the workspace default for this organization
  • Omit fields you do not want to change (they remain unchanged)

Example use cases:

  • Enable table of contents for a specific customer: { “projectDocumentEnableToc”: true }
  • Reset to workspace default: { “projectDocumentEnableToc”: null }
  • Set multiple settings at once: { “projectDocumentEnableToc”: true, “projectDocumentTitlePage”: false }

Note: This endpoint requires the Organizations.edit permission. The organization must exist in your workspace and not be deleted.

PATCH/organizations/{id}/document-settings
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:write
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
idstringrequired
Request body
requiredapplication/json
documentLanguageobject
Document language override for this organization. Overrides workspace default. Set to null to inherit workspace default. Omit this field to leave it unchanged.
offerTextsobject
Offer text overrides for this organization. Overrides workspace defaults. Set to null to inherit workspace defaults. Omit this field to leave it unchanged.
Show properties
offerIntroTextobject | null
Custom intro text for offers (HTML or Markdown). Overrides workspace default. Set to null to clear.
offerOutroTextobject | null
Custom outro text for offers (HTML or Markdown). Overrides workspace default. Set to null to clear.
projectDocumentDefaultContactUserIdobject | null
UUID of the organization member (contact person) to set as the default recipient for new project documents. Set to `null` to clear the default contact. Omit this field to leave it unchanged.
projectDocumentEnableTocobject | null
Whether to automatically include a table of contents in project documents. Set to `null` to inherit the workspace default, `true` to enable, or `false` to disable. Omit this field to leave it unchanged.
projectDocumentHeadingStylestring | null
Formatting style for headings in project documents (e.g., Sequential, Normal). Set to `null` to inherit the workspace default, or provide a specific style to override. Omit this field to leave it unchanged.
Allowed:NormalSequentialSequentialFromSecondLevelSequentialWithParagraphs
projectDocumentTitlePageobject | null
Whether to include a title/cover page in project documents. Set to `null` to inherit the workspace default, `true` to enable, or `false` to disable. Omit this field to leave it unchanged.
Responses
200
successbooleanrequired
Operation success flag
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X PATCH "https://leadtime.app/api/public/organizations/string/document-settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "documentLanguage": "de",
  "offerTexts": {
    "offerIntroText": {},
    "offerOutroText": {}
  },
  "projectDocumentDefaultContactUserId": "123e4567-e89b-12d3-a456-426614174000",
  "projectDocumentEnableToc": true,
  "projectDocumentHeadingStyle": "Sequential",
  "projectDocumentTitlePage": false
}'
Response
{
  "success": true
}