PUT Workgroup

Provide a REST API endpoint to update an existing Workgroup master record within the Incident Management (IM) module. The API enables modification of Workgroup attributes and associated child entities, such as Workgroup Locations, through a single update operation.

Endpoint

This endpoint updates an existing Workgroup record identified by its unique identifier (UID). It allows authorized users and integration systems to change Workgroup configuration, notification settings, SLA alert settings, and associated location mappings.

PUT /API/v1/Master/IM/Workgroup/{UID}

Endpoint Path Parameters

Parameter Name	Data Type	Required	Description	Example
UID	integer/string	Yes	Unique identifier of the Workgroup record to update.	101

Note: Before updating Workgroup record, system retrieves its update metadata to review required fields, supported fields, payload structure, validation constraints, and applicable endpoint. GET /API/v1/Master/IM/Workgroup/metadata?sections=update,children.

Sample Request

The sample request demonstrates how to update an existing Workgroup record using its unique identifier (UID). The request includes the Workgroup attributes and associated child entity information that you can change as part of the update operation.

{
  "Active": true,
  "Alternate_Workgroup_ID": null,
  "Is_Enable_CL": false,
  "Is_Enable_CM_And_CMDB": false,
  "Is_Enable_IM_And_PM": true,
  "Is_Notify_Workgroup_Owner_For_Incident": true,
  "Is_Default": false,
  "Is_Enable_Live_Agent_Transfer": true,
  "Is_Master_Workgroup": true,
  "Manager": "Carlos.Rivera",
  "Parent_ID": null,
  "Response_Alert_On_50_Percentage": true,
  "Response_Alert_On_75_Percentage": true,
  "Resolution_Alert_On_100_Percentage": true,
  "Resolution_Alert_On_50_Percentage": false,
  "Resolution_Alert_On_75_Percentage": true,
  "Response_Alert_On_100_Percentage": true,
  "Is_Enable_SR": false,
  "Description": "wg Description",
  "Locations": null,
  "children": {
    "workgroup_locations": [
      {
        "Is_Default": true,
        "Location": "Bangalore"
      }
    ]
  }
}

Request Body Fields

Field Name	Data Type	Description
Active	Boolean	Indicates whether the Workgroup is active.
Alternate_Workgroup_ID	String/Null	Reference to an alternate Workgroup.
Is_Enable_CL	Boolean	Enables Change Lifecycle functionality.
Is_Enable_CM_And_CMDB	Boolean	Enables Configuration Management and CMDB functionality.
Is_Enable_IM_And_PM	Boolean	Enables Incident Management and Problem Management functionality.
Is_Notify_Workgroup_Owner_For_Incident	Boolean	Sends notifications to the Workgroup Owner for incidents.
Is_Default	Boolean	Indicates whether the Workgroup is the default Workgroup.
Is_Enable_Live_Agent_Transfer	Boolean	Enables Live Agent Transfer functionality.
Is_Master_Workgroup	Boolean	Designates the Workgroup as a Master Workgroup.
Manager	String	Workgroup Manager/User ID.
Parent_ID	String/Null	Parent Workgroup reference.
Response_Alert_On_50_Percentage	Boolean	Triggers a response SLA alert at 50% threshold.
Response_Alert_On_75_Percentage	Boolean	Triggers a response SLA alert at 75% threshold.
Response_Alert_On_100_Percentage	Boolean	Triggers a response SLA alert at 100% threshold.
Resolution_Alert_On_50_Percentage	Boolean	Triggers a resolution SLA alert at 50% threshold.
Resolution_Alert_On_75_Percentage	Boolean	Triggers a resolution SLA alert at 75% threshold.
Resolution_Alert_On_100_Percentage	Boolean	Triggers a resolution SLA alert at 100% threshold.
Is_Enable_SR	Boolean	Enables Service Request functionality.
Description	String	Detailed description of the Workgroup.
Locations	String/Null	Associated location information for the Workgroup.
children.workgroup_locations	Array	Child collection containing associated Workgroup Locations.

Child Entity: workgroup_locations

Field Name	Data Type	Description
Is_Default	Boolean	Indicates whether the location is the default Workgroup location.
Location	String	Location associated with the Workgroup.

Sample Response

The response confirms that the Workgroup record was successfully updated. A successful operation returns a confirmation message and the unique identifier of the updated record.

{
  "message": "Workgroup updated successfully.",
  "UID": 101
}

Sample Response Field Details

Field Name	Sample Value	Data Type	Description
message	`"Workgroup updated successfully."`	String	Confirms that the Workgroup update operation completed successfully.
UID	`101`	Integer	Unique identifier of the Workgroup record updated by the request.

Sample Response Explanation

Response Attribute	Returned Value	Meaning
Response Message	`"Workgroup updated successfully."`	Confirms that the Workgroup record was updated successfully.
Updated Record Identifier	`101`	Identifies the Workgroup record affected by the update operation.

Expected Result

The Workgroup record was successfully updated and the system saved all submitted changes. The response confirms completion of the update operation and returns the identifier of the updated record.

Response: HTTP 200 OK

{
  "message": "Workgroup updated successfully.",
  "UID": 101
}

Error Responses

400 Bad Request

The system cannot process the request because the submitted payload is invalid or does not meet the required validation rules. Review the request body for missing mandatory fields, incorrect data types, or invalid values.

{
  "success": false,
  "message": "Invalid request payload."
}

401 Unauthorized

The request failed authentication because the client did not provide valid API credentials or the credentials have expired. Include a valid API key or authentication token in the request.

{
  "success": false,
  "message": "Authentication failed."
}

403 Forbidden

The authenticated user lacks permissions to update Workgroup records. Contact the system administrator to get the required access rights.

{
  "success": false,
  "message": "User is not authorized to update Workgroup records."
}

Documentation Index