PUT Tenant

Provide a REST API endpoint to update an existing Tenant/Instance master record within the Incident Management (IM) module. The API enables modification of Tenant attributes and associated child entities, such as Instance Details, Instance Modules, and Email Notification configurations, through a single update operation.

Endpoint

This endpoint updates an existing Tenant/Instance record identified by its unique identifier (recordId). It allows authorized users and integration systems to change tenant configuration settings, module configurations, and notification preferences.

PUT /API/v1/Master/IM/Instance/{recordId}

Endpoint Path Parameters

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

Sample Request

The sample request demonstrates how to update an existing Tenant/Instance record using its unique identifier. The request includes tenant configuration details and associated child entity information that you change as part of the update operation.

{
  "Active": true,
  "Sort_Order": 1,
  "Group": 0,
  "Description": "Information Technology-11 desc",
  "Text": "Information Technology-11",
  "children": {
    "instance_detail": [
      {
        "Is_Active": true,
        "Is_Allow_Analyst_EditDescription": false,
        "Is_Allow_Analyst_EditSymptom": true,
        "Is_Allow_Workgroup_Owner_Edit_Priority": true,
        "Email_Notification": 1,
        "Is_Enable_Additional_Information_Tab": true,
        "Is_Enable_Bulk_Update_Icon_on_List_Page": true,
        "Is_Enable_Checklist_Tab": true,
        "Is_Enable_Capture_Closure_Category": true,
        "Is_Enable_Display_End_User_Followup_Details": true,
        "Is_Enable_Major_Incident_Option": true,
        "Is_Enable_Vendor_Information_Tab": true,
        "Is_Enable_Service_Automation_Tab": true,
        "Is_Enable_Troubleshooting_Tab": true,
        "Is_Enable_Conference_Call": true,
        "Is_Enable_First_Call_Resolution_Option": true,
        "Auto_Assignment_Type": "CO",
        "Is_Enable_Change_Caller_Icon": true,
        "Is_Enable_Auto_Assignment_Incidents": true,
        "Is_Enable_Linking_KBs_Resolved_Incidents": true,
        "Is_Minimized_Knowledge_Base_Popup_Page": true,
        "Is_Enable_Enable_Last_5_Incidents_Popup": true,
        "Is_Enable_Auto_Completion_Logging Incidents": true,
        "Is_Allow_Creation_Incident_Global_Users": true,
        "Module": "IM",
        "Incident_Closing_Mode": "Manual",
        "Is_Enable_View_Other_Workgroup_Incidents": true
      }
    ],
    "instance_modules": [
      {
        "Is_Config_Complete": false,
        "Is_Enabled": true,
        "Module": "IM"
      }
    ],
    "instance_im_email_notification_options": [
      {
        "Enabled": false,
        "Mail_To_Caller": false,
        "Mail_To_CC": false,
        "Mail_To_Workgroup": false,
        "Module": "IM",
        "Status": "New"
      }
    ]
  }
}

Request Body Fields

Child Entity: instance_detail

Child Entity: instance_modules

Child Entity: instance_im_email_notification_options

Sample Response

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

{
  "message": "Instance updated successfully.",
  "UID": 1001
}

Sample Response Field Details

Sample Response Explanation

Success Response

HTTP 200 OK

The Tenant/Instance record was successfully updated, and the system saved the submitted changes. The response confirms completion of the update operation and returns the identifier of the updated record.

{
  "message": "Instance updated successfully.",
  "UID": 1001
}

HTTP 200 Response Details

A successful request returns HTTP 200 OK. The response confirms that the system successfully updated the Tenant/Instance record with UID 1001.

Error Messages

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.

{
  "message": "Invalid request payload.",
  "errorCode": 400,
  "details": "One or more fields failed validation."
}

401 Unauthorized

The system cannot authenticate the request because valid API credentials were not provided or have expired. Ensure you include a valid API key or authentication token in the request.

{
  "message": "Unauthorized access.",
  "errorCode": 401,
  "details": "Valid API credentials are required."
}

403 Forbidden

The authenticated user does not have the required permissions to update Tenant/Instance records. Contact the system administrator to get the required access rights.

{
  "message": "You do not have permission to update Tenant/Instance records.",
  "errorCode": 403,
  "details": "The authenticated user lacks the required privileges to perform this operation."
}

404 Not Found

The specified Tenant/Instance record does not exist or is unavailable in the system. Verify the provided record identifier and ensure the record exists before resubmitting the request.

{
  "message": "Tenant/Instance record not found.",
  "errorCode": 404,
  "details": "No record was found for the specified identifier."
}