Update project document settings
Partially updates document settings for a specific project. All fields are optional - only provided fields will be updated.
What are Project Document Settings? Project document settings control formatting options and contact information for automatically generated documents such as proposals, contracts, requirement specifications, and other project documents. These settings can override organization/workspace defaults on a per-project basis.
Settings You Can Update:
- projectDocumentTitlePage: Enable/disable title page for generated documents (null = use organization standard)
- projectDocumentEnableToc: Enable/disable table of contents in generated documents (null = use organization standard)
- projectDocumentHeadingStyle: Set heading numbering style (null = use organization standard)
- Normal: No numbering
- Sequential: Numbering from level 1
- SequentialFromSecondLevel: Numbering from level 2
- SequentialWithParagraphs: Numbering with symbol prefix (e.g., §)
- projectDocumentDefaultContactUserId: Set default contact person UUID for new documents (null = use organization standard or no default)
Inheritance Behavior: Setting any field to null enables inheritance from organization/workspace defaults. This allows you to override organization settings for specific projects or revert to using organization standards.
Use Cases:
- Customize document formatting for specific project types
- Set project-specific contact persons for recurring offer processes
- Override organization defaults when needed
- Revert to organization standards by setting fields to null
PATCH
/projects/{id}/document-settingsAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:writeor
AuthorizationBearer token (JWT) · headerrequiredPath parameters
idstringrequiredRequest body
requiredapplication/jsonprojectDocumentDefaultContactUserIdobject | nullDefault contact person user ID for project documents. Set to a valid user UUID to automatically set this person as contact when creating new documents, or null to inherit from organization default (if set) or remove the default contact. Useful for recurring offer processes and automated preambles. Must be a valid UUID of a user in the workspace. All fields in this DTO are optional - only provided fields will be updated.
projectDocumentEnableTocobject | nullEnable table of contents for project documents. Set to true to enable table of contents, false to disable, or null to inherit from organization/workspace default. This setting is especially helpful for long documents and makes them easier to navigate. All fields in this DTO are optional - only provided fields will be updated.
projectDocumentHeadingStylestring | nullHeading style for project documents. Controls the numbering and formatting of headings in generated documents. Set to a specific style to override, or null to inherit from organization/workspace default. Available styles: Normal (no numbering), Sequential (numbering from level 1), SequentialFromSecondLevel (numbering from level 2), SequentialWithParagraphs (numbering with symbol prefix like §). This feature keeps document outlines consistent, especially in contract documents. All fields in this DTO are optional - only provided fields will be updated.
Allowed:
NormalSequentialSequentialFromSecondLevelSequentialWithParagraphsprojectDocumentTitlePageobject | nullEnable title page for project documents. Set to true to enable title page, false to disable, or null to inherit from organization/workspace default. All fields in this DTO are optional - only provided fields will be updated.
Responses
200
successbooleanrequiredOperation success flag
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X PATCH "https://leadtime.app/api/public/projects/string/document-settings" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"projectDocumentDefaultContactUserId": "550e8400-e29b-41d4-a716-446655440001",
"projectDocumentEnableToc": true,
"projectDocumentHeadingStyle": "Sequential",
"projectDocumentTitlePage": true
}'const response = await fetch("https://leadtime.app/api/public/projects/string/document-settings", {
method: "PATCH",
headers: {
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({
"projectDocumentDefaultContactUserId": "550e8400-e29b-41d4-a716-446655440001",
"projectDocumentEnableToc": true,
"projectDocumentHeadingStyle": "Sequential",
"projectDocumentTitlePage": true
})
});import requests
response = requests.patch(
"https://leadtime.app/api/public/projects/string/document-settings",
headers={
"Authorization": "Bearer YOUR_ACCESS_TOKEN",
"Content-Type": "application/json"
},
json={
"projectDocumentDefaultContactUserId": "550e8400-e29b-41d4-a716-446655440001",
"projectDocumentEnableToc": True,
"projectDocumentHeadingStyle": "Sequential",
"projectDocumentTitlePage": True
},
)Response
{
"success": true
}Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions