POST Tenant

Provide a REST API endpoint to create a new Tenant/Instance master record within the Incident Management (IM) module. The API enables creation of Tenant records along with associated child configurations such as Instance Details, Instance Modules, and Email Notification settings in a single transaction.

Endpoint

This endpoint creates a new Tenant/Instance record in the IM module. It allows authorized users, integrations, and automation tools to establish tenant configurations and related child entities required for service management operations.

POST /API/v1/Master/IM/Instance

Path Parameters

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

Sample Request

The sample request demonstrates how to create a new Tenant/Instance record. The request includes basic tenant information along with associated child entity configurations that the API creates as part of the operation.

{
  "Active": true,
  "Domain": 1,
  "Sort_Order": 1,
  "Group": 0,
  "Value": "IT1",
  "Description": "Information Technology-1 desc",
  "Text": "Information Technology-1",
  "children": {
    "instance_detail": [
      {
        "Is_Active": true,
        "Is_Allow_Analyst_EditDescription": true,
        "Is_Allow_Analyst_EditSymptom": true,
        "Is_Allow_Workgroup_Owner_Edit_Priority": true,
        "Email_Notification": 2,
        "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_im_email_notification_options": [
      {
        "Enabled": false,
        "Mail_To_Caller": false,
        "Mail_To_CC": false,
        "Mail_To_Workgroup": false,
        "Module": "IM",
        "Status": "New"
      }
    ],
    "instance_modules": [
      {
        "Is_Config_Complete": false,
        "Is_Enabled": true,
        "Module": "IM"
      }
    ]
  }
}

Request Body Fields

Child Entity: instance_detail

Child Entity: instance_im_email_notification_options

Child Entity: instance_modules

Sample Response

The response confirms that the Tenant/Instance has been successfully created. The response returns a newly generated unique identifier for future retrieval and update operations.

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

Success Response

The Tenant/Instance record has been successfully created and stored in the system. The response returns the unique identifier of the newly created record for future reference.

Response: HTTP 201 Created

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

Error Messages

400 Bad Request

The server could not 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 server cannot authenticate the request because the client did not provide valid API credentials or they have expired. 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 required permissions to create Tenant/Instance records. Contact the system administrator to get the required access rights.

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