> ## Documentation Index > Fetch the complete documentation index at: https://docs.stardex.com/llms.txt > Use this file to discover all available pages before exploring further. # Update Team Capacity settings > Updates the shared Team Capacity board settings for the whole team. Send only the settings you want to change: nested objects merge field by field, `role_weights` entries update one role each, and the filter arrays replace the current value. Job status and role names must match `available_job_statuses` and the team’s job team roles (see `available_roles` on `GET /v1/team-capacity`). Returns the saved settings. Roles without a saved weight are left out; `GET /v1/team-capacity` shows the default weight it applies to them. Only organization admins can update these settings. API keys need the `reports:write` scope. ## OpenAPI ````yaml /api-reference/openapi-v1.json patch /v1/team-capacity/settings openapi: 3.1.0 info: title: Stardex API (v1) version: 1.0.0 description: >- Stardex ATS API — manage candidates, jobs, companies, and recruiting workflows. servers: - url: https://api.stardex.ai description: Production API server security: - bearerAuth: [] tags: - name: Persons description: Manage person records — contacts, work history, and custom fields. - name: Jobs description: Manage job postings — pipeline stages, team members, and custom fields. - name: Candidates description: Manage candidate records and pipeline stage transitions. - name: Companies description: Browse and retrieve company records. - name: Lists description: Create, search, and retrieve saved person and company lists. - name: Person Activities description: Create and manage activity records (notes, emails, meetings) for persons. - name: Team Members description: List team members for use in search filters and assignments. - name: Custom Fields description: Retrieve custom field definitions and tag options for search filters. paths: /v1/team-capacity/settings: patch: tags: - Team Capacity summary: Update Team Capacity settings description: >- Updates the shared Team Capacity board settings for the whole team. Send only the settings you want to change: nested objects merge field by field, `role_weights` entries update one role each, and the filter arrays replace the current value. Job status and role names must match `available_job_statuses` and the team’s job team roles (see `available_roles` on `GET /v1/team-capacity`). Returns the saved settings. Roles without a saved weight are left out; `GET /v1/team-capacity` shows the default weight it applies to them. Only organization admins can update these settings. API keys need the `reports:write` scope. operationId: updateTeamCapacitySettings requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamCapacitySettingsUpdate' responses: '200': description: Team Capacity settings updated content: application/json: schema: $ref: '#/components/schemas/TeamCapacitySettingsResponse' example: success: true data: show_search_stage: true stage_config: stage_1_name: New stage_1_max_weeks: 2 stage_2_name: Active stage_2_max_weeks: 4 stage_3_name: Ongoing show_load_score: true role_weights: - role_name: Lead Recruiter weight: 75 - role_name: Sourcer weight: 25 enable_active_search_color_coding: true active_search_color_thresholds: moderate_min: 5 heavy_min: 8 job_status_filter: - Active - On Hold role_filter: [] sort: column: total_searches direction: desc '400': description: Validation error content: application/json: schema: type: object properties: success: type: boolean enum: - false description: Always false for error responses. error: type: object properties: code: type: string description: >- Machine-readable error code (e.g. "VALIDATION_ERROR", "NOT_FOUND"). message: type: string description: Human-readable error description. required: - code - message required: - success - error '404': description: Resource not found content: application/json: schema: type: object properties: success: type: boolean enum: - false description: Always false for error responses. error: type: object properties: code: type: string description: >- Machine-readable error code (e.g. "VALIDATION_ERROR", "NOT_FOUND"). message: type: string description: Human-readable error description. required: - code - message required: - success - error '500': description: Internal server error content: application/json: schema: type: object properties: success: type: boolean enum: - false description: Always false for error responses. error: type: object properties: code: type: string description: >- Machine-readable error code (e.g. "VALIDATION_ERROR", "NOT_FOUND"). message: type: string description: Human-readable error description. required: - code - message required: - success - error components: schemas: TeamCapacitySettingsUpdate: type: object properties: show_search_stage: type: boolean description: Show or hide the search stage columns. stage_config: type: object properties: stage_1_name: type: string minLength: 1 maxLength: 40 stage_1_max_weeks: type: integer minimum: 1 maximum: 51 stage_2_name: type: string minLength: 1 maxLength: 40 stage_2_max_weeks: type: integer minimum: 2 maximum: 52 stage_3_name: type: string minLength: 1 maxLength: 40 description: >- Stage names and week limits. Fields you leave out keep their current value. `stage_2_max_weeks` must stay greater than `stage_1_max_weeks`. show_load_score: type: boolean description: Show or hide the load score column. role_weights: type: array items: type: object properties: role_name: type: string minLength: 1 maxLength: 120 description: Role name from `available_roles`. weight: type: - integer - 'null' minimum: 0 maximum: 999 description: >- New weight for this role. Pass null to go back to the default weight. required: - role_name - weight maxItems: 100 description: >- Role weights to change. Roles you leave out keep their current weight. enable_active_search_color_coding: type: boolean description: Turn workload color coding on member names on or off. active_search_color_thresholds: type: object properties: moderate_min: type: integer minimum: 1 maximum: 998 heavy_min: type: integer minimum: 2 maximum: 999 description: >- Workload thresholds. Fields you leave out keep their current value. `heavy_min` must stay greater than `moderate_min`. job_status_filter: type: array items: type: string minLength: 1 maxLength: 120 maxItems: 100 description: >- Replaces the job status filter. Names must match `available_job_statuses`. Pass an empty array to include every status. role_filter: type: array items: type: string minLength: 1 maxLength: 120 maxItems: 100 description: >- Replaces the role filter. Names must match the team’s job team roles. Pass an empty array to include every role. sort: type: object properties: column: type: string minLength: 1 maxLength: 120 description: >- Column the board is sorted by. One of `member`, `title`, `total_searches`, `stage_1`, `stage_2`, `stage_3`, `load_score`, `kicked_off_this_quarter`, `closed_this_quarter`, `avg_days_out`, `avg_days_left`, `ytd_avg_fill_days`, or a role name to sort by that role’s column in the Role Breakdown. direction: type: string enum: - asc - desc default: desc description: Sort direction. Defaults to `desc`. required: - column description: Default sort for the board. TeamCapacitySettingsResponse: type: object properties: success: type: boolean enum: - true data: $ref: '#/components/schemas/TeamCapacitySettings' required: - success - data TeamCapacitySettings: type: object properties: show_search_stage: type: boolean description: Whether the board shows the search stage columns. stage_config: $ref: '#/components/schemas/TeamCapacityStageConfig' show_load_score: type: boolean description: Whether the board shows the weighted load score column. role_weights: type: array items: $ref: '#/components/schemas/TeamCapacityRoleWeight' description: >- Load score weight for each role. Roles without a saved weight get a default: the owner role gets more weight and the remaining roles share the rest. enable_active_search_color_coding: type: boolean description: >- Whether member names are colored light, moderate, or heavy by active search count. active_search_color_thresholds: $ref: '#/components/schemas/TeamCapacityColorThresholds' job_status_filter: type: array items: type: string description: >- Job status names included in the report. Empty means every status. Until an admin saves settings, this defaults to every status that is not closed won or closed lost. role_filter: type: array items: type: string description: >- Role names included in the report. A member’s search only counts when they hold one of these roles on it. Empty means every role. sort: $ref: '#/components/schemas/TeamCapacitySort' required: - show_search_stage - stage_config - show_load_score - role_weights - enable_active_search_color_coding - active_search_color_thresholds - job_status_filter - role_filter - sort TeamCapacityStageConfig: type: object properties: stage_1_name: type: string description: Display name for the first stage (newest searches). stage_1_max_weeks: type: integer description: Searches kicked off up to this many weeks ago fall in stage 1. stage_2_name: type: string description: Display name for the second stage. stage_2_max_weeks: type: integer description: >- Searches older than stage 1 and up to this many weeks old fall in stage 2. Always greater than `stage_1_max_weeks`. stage_3_name: type: string description: >- Display name for the third stage. Holds every active search older than `stage_2_max_weeks`. required: - stage_1_name - stage_1_max_weeks - stage_2_name - stage_2_max_weeks - stage_3_name TeamCapacityRoleWeight: type: object properties: role_name: type: string description: Job team role name. weight: type: integer description: >- Points a member earns toward their load score for each active search where they hold this role. required: - role_name - weight TeamCapacityColorThresholds: type: object properties: moderate_min: type: integer description: >- Members with at least this many active searches are shown as moderate (yellow). heavy_min: type: integer description: >- Members with at least this many active searches are shown as heavy (red). Always greater than `moderate_min`. required: - moderate_min - heavy_min TeamCapacitySort: type: object properties: column: type: string description: >- Column the board is sorted by. One of `member`, `title`, `total_searches`, `stage_1`, `stage_2`, `stage_3`, `load_score`, `kicked_off_this_quarter`, `closed_this_quarter`, `avg_days_out`, `avg_days_left`, `ytd_avg_fill_days`, or a role name to sort by that role’s column in the Role Breakdown. direction: type: string enum: - asc - desc description: Sort direction. required: - column - direction securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Authenticate with a Bearer token: API key, OAuth token, or session token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.