> ## Documentation Index > Fetch the complete documentation index at: https://docs.flexxible.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a reporting group > Updates the configuration of an existing reporting group, including name, description, patch policy target, search pattern, and intermediate devices. This endpoint implements full replacement semantics: all updateable fields must be included in the request. Omitting optional fields will clear them (idempotent behavior). Optionally configure intermediate devices (up to 3) by providing Workspace identifiers. Intermediate devices are used for actions like Wake-on-LAN in secure networks, allowing remote powering on of devices through intermediate gateways. Intermediate devices must be defined sequentially: you cannot define intermediate_device_2_id without intermediate_device_1_id, nor intermediate_device_3_id without intermediate_device_2_id. All intermediate device Workspace IDs must exist and belong to the organization. Returns the updated resource (200) after a successful update. ## OpenAPI ````yaml /en/api-reference/openapi.en-v1.json put /v1/organizations/{organization_id}/reporting-groups/{reporting_group_id} openapi: 3.0.3 info: title: Public Portal API version: 1.0.0 description: Public REST API for portal servers: - url: https://api.staging.flxwvdexternal.com description: Staging API server. security: - bearerAuth: [] tags: [] paths: /v1/organizations/{organization_id}/reporting-groups/{reporting_group_id}: put: tags: - Reporting Groups summary: Update a reporting group description: >- Updates the configuration of an existing reporting group, including name, description, patch policy target, search pattern, and intermediate devices. This endpoint implements full replacement semantics: all updateable fields must be included in the request. Omitting optional fields will clear them (idempotent behavior). Optionally configure intermediate devices (up to 3) by providing Workspace identifiers. Intermediate devices are used for actions like Wake-on-LAN in secure networks, allowing remote powering on of devices through intermediate gateways. Intermediate devices must be defined sequentially: you cannot define intermediate_device_2_id without intermediate_device_1_id, nor intermediate_device_3_id without intermediate_device_2_id. All intermediate device Workspace IDs must exist and belong to the organization. Returns the updated resource (200) after a successful update. operationId: updateReportingGroup parameters: - name: organization id in: path required: true schema: type: string maxLength: 24 pattern: ^[0-9a-f]{24}$ description: The unique identifier of the organization example: 507f1f77bcf86cd799439011 - name: reporting_group_id in: path required: true schema: type: string maxLength: 24 pattern: ^[0-9a-f]{24}$ description: The unique identifier of the reporting group to be updated example: 507f1f77bcf86cd799439020 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateReportingGroupRequestV1' examples: update-reporting-group-full-replacement: summary: >- Update reporting group with all updatable fields, including intermediate devices value: name: Updated Production Reporting Group description: Updated Reporting Group for Production Environments patch_policy_target_id: 507f1f77bcf86cd799439040 fishing_pattern: Windows Workstations fishing_pattern_field: full_name intermediate_device_1_id: 507f1f77bcf86cd799439050 intermediate_device_2_id: 507f1f77bcf86cd799439051 intermediate_device_3_id: 507f1f77bcf86cd799439052 update-reporting-group-minimal-fields: summary: >- Update reporting group with only mandatory fields (clears all optional fields) value: name: Updated Reporting Group Name description: >- This example shows the update of name only. All optional fields (description, patch_policy_target_id, fishing_pattern, fishing_pattern_field, and intermediate devices) will be cleared. update-reporting-group-with-single-intermediate-device: summary: Update reporting group with just the first intermediate device value: name: Updated Reporting Group Name description: Single Intermediate Device Configuration intermediate_device_1_id: 507f1f77bcf86cd799439050 description: >- This example sets only intermediate_device_1_id. intermediate_device_2_id and intermediate_device_3_id will be cleared if they were previously set. update-reporting-group-clear-intermediate-devices: summary: Update reporting group and clear all intermediate devices value: name: Updated Reporting Group Name description: No Intermediate Devices description: >- By omitting all fields intermediate_device_*_id, all will be cleared (idempotent behavior). responses: '200': description: >- Reporting group updated successfully. The response contains the updated resource. content: application/json: schema: $ref: '#/components/schemas/ReportingGroupByIdV1' '400': $ref: '#/components/responses/BadRequest' description: >- Invalid request. Common causes: - Mandatory fields are missing (name) - Invalid field values - Invalid fishing_pattern_field value (must be one of: full_name, description, ou, current_subnet) - Fishing_pattern value too long (exceeds maxLength: 250) - Invalid ID format for patch_policy_target_id or intermediate_device_*_id fields - Intermediate devices not defined sequentially (intermediate_device_2_id requires intermediate_device_1_id, intermediate_device_3_id requires intermediate_device_2_id) '401': $ref: '#/components/responses/Unauthorized' description: Unauthorized - authentication required '404': $ref: '#/components/responses/NotFound' description: >- Not found. Common causes: - Report group not found or does not belong to the organization - Patch policy target not found '422': $ref: '#/components/responses/UnprocessableEntity' description: >- Unprocessable entity. Common causes: - Intermediate device Workspace IDs do not exist or do not belong to the organization '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' components: schemas: UpdateReportingGroupRequestV1: type: object properties: name: type: string maxLength: 512 description: The reporting group name. Must be unique within the organization. example: Updated Production Reporting Group description: type: string maxLength: 1000 description: Optional. A description of the reporting group's purpose and usage. example: Updated Reporting Group for Production Environments patch_policy_target_id: type: string maxLength: 24 pattern: ^[0-9a-f]{24}$ description: >- Optional. The unique identifier of the patch policy target to be associated with this reporting group. Set it to null or omit it to remove the association. example: 507f1f77bcf86cd799439040 fishing_pattern: type: string maxLength: 250 description: >- Optional. A regular expression pattern used to match devices. Must be a valid regex pattern. If provided, fishing_pattern_field must also be specified. Omit to remove the pattern. example: Windows Workstations fishing_pattern_field: type: string enum: - full_name - description - ou - current_subnet description: >- Optional. Field to which fishing_pattern is applied. Required if fishing_pattern is provided. Valid values: full_name (full device name), description (device description), ou (organizational unit), current_subnet (current subnet). example: full_name intermediate_device_1_id: type: string maxLength: 24 pattern: ^[0-9a-f]{24}$ description: >- Optional. The unique identifier of the Workspace of the first intermediate device. Intermediate devices are used for Wake-on-LAN actions in secure networks, allowing remote powering on of target devices through intermediate gateways. Intermediate devices must be sequentially defined without gaps. Omitting will clear all intermediate devices. If intermediate_device_2_id or intermediate_device_3_id is provided, this field is required. example: 507f1f77bcf86cd799439050 intermediate_device_2_id: type: string maxLength: 24 pattern: ^[0-9a-f]{24}$ description: >- Optional. The unique identifier of the Workspace of the second intermediate device. Used for Wake-on-LAN actions in secure networks. Requires intermediate_device_1_id to be provided. If omitted while intermediate_device_1_id is provided, this and intermediate_device_3_id will be cleared. If intermediate_device_3_id is provided, this field is required. example: 507f1f77bcf86cd799439051 intermediate_device_3_id: type: string maxLength: 24 pattern: ^[0-9a-f]{24}$ description: >- Optional. The unique identifier of the Workspace of the third intermediate device. Used for actions like Wake-on-LAN in secure networks. Requires both intermediate_device_1_id and intermediate_device_2_id to be provided. If omitted while intermediate_device_1_id and intermediate_device_2_id are provided, this field will be cleared. example: 507f1f77bcf86cd799439052 required: - name description: >- Request body to update an existing reporting group. This endpoint implements complete replacement semantics: all updateable fields must be included. Optional fields omitted will be cleared (idempotent behavior). Intermediate devices are used for Wake-on-LAN actions in secure networks, allowing remote powering on of devices through intermediate gateways. Intermediate devices must be defined sequentially: you cannot define intermediate_device_2_id without intermediate_device_1_id, nor intermediate_device_3_id without intermediate_device_2_id. All intermediate device Workspace IDs must exist and belong to the organization. ReportingGroupByIdV1: type: object properties: id: type: string description: Reporting group Id name: type: string description: Name of the reporting group organization_id: type: string nullable: true description: Organization identifier product_config_id: type: string nullable: true description: Product configuration identifier fishing_pattern: type: string nullable: true description: Fishing pattern name fishing_pattern_field: type: string enum: - full_name - description - ou - current_subnet nullable: true description: >- Field to which fishing_pattern is applied. Possible values: full_name, description, ou, current_subnet. patch_policy_target_id: type: string nullable: true description: Patch policy target identifier policy_reporting_group: type: string nullable: true description: Policy reporting group identifier overridden_agent_settings: $ref: '#/components/schemas/ReportingGroupAgentSettingsV1' nullable: true description: Agent settings overridden at the reporting group level effective_agent_settings: $ref: '#/components/schemas/ReportingGroupEffectiveAgentSettingsV1' nullable: true description: >- Effective agent settings (combined from product configuration and overrides) execute_flexx_analyzer_agent: type: boolean description: If Flexx Analyzer agent execution is enabled intermediate_device_1_id: type: string nullable: true description: Workspace ID of the first intermediary device (searched by sysId) intermediate_device_2_id: type: string nullable: true description: Workspace ID of the second intermediary device (searched by sysId) intermediate_device_3_id: type: string nullable: true description: Workspace ID of the third intermediary device (searched by sysId) required: - id - name - execute_flexx_analyzer_agent ReportingGroupAgentSettingsV1: type: object properties: remote_support: type: string nullable: true description: Remote support configuration collect_device_location: type: boolean nullable: true description: If device location collection is enabled auto_update_agents: type: boolean nullable: true description: If automatic agent updates are enabled collect_event_logs: type: boolean nullable: true description: If event log collection is enabled event_log_ids: type: string nullable: true description: Event log record IDs event_logs_recurrence: type: number nullable: true description: Event logs recurrence collect_disks: type: boolean nullable: true description: If disk collection is enabled collect_services: type: boolean nullable: true description: If service collection is enabled collect_pnp_events: type: boolean nullable: true description: If PnP event collection is enabled collect_public_ip: type: boolean nullable: true description: If public IP collection is enabled fra_system_actions_role: type: string nullable: true description: FRA system actions role unified_reporting: type: string nullable: true description: Unified reporting configuration unified_operations: type: string nullable: true description: Unified operations configuration uninstall_protection: type: string nullable: true enum: - 'off' - 'on' description: 'Possible values: off, on. Returns null if no applicable status.' web_apps: type: boolean nullable: true description: If web apps are enabled ReportingGroupEffectiveAgentSettingsV1: type: object description: >- Effective agent settings (includes product configuration fields plus overrides) properties: remote_support: type: string nullable: true collect_device_location: type: boolean nullable: true auto_update_agents: type: boolean nullable: true collect_event_logs: type: boolean nullable: true event_log_ids: type: string nullable: true event_logs_recurrence: type: number nullable: true collect_disks: type: boolean nullable: true collect_services: type: boolean nullable: true collect_pnp_events: type: boolean nullable: true collect_public_ip: type: boolean nullable: true fra_system_actions_role: type: string nullable: true unified_reporting: type: string nullable: true uninstall_protection: type: string nullable: true enum: - 'off' - 'on' description: 'Possible values: off, on. Returns null if no applicable status.' resources_report_recurrence: type: number nullable: true profile_storage_report_recurrence: type: number nullable: true sync_broker_recurrence: type: number nullable: true detect_new_citrix_subscriptions: type: boolean nullable: true proxy_type: type: string nullable: true can_enable_flexx_agent_per_group: type: boolean nullable: true web_apps: type: boolean nullable: true fra_simplified_security: type: string nullable: true ErrorResponse: type: object properties: error: type: object properties: message: type: string code: type: string details: type: string required: - message - code required: - error responses: BadRequest: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' UnprocessableEntity: description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' TooManyRequests: description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalServerError: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````