Note: To upload the photo, generate an OAuth token for the scope Desk.basic.UPDATE, zohoprofile.userphoto.UPDATE.
", "operationId" : "uploadMyPhoto", "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : [ "object" ], "properties" : { "userPhoto" : { "type" : [ "string" ], "format" : "binary", "description" : "Image file containing the agent photoNote: - Maximum file size allowed is 500 KB - Maximum file limit is one - Allowed extensions are jpg, png, gif, and jpeg
" } }, "required" : [ "userPhoto" ], "additionalProperties" : false } } } }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/myPhotoResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.UPDATE" ] } ] } }, "/api/v1/agents/{agentId}/reassignment" : { "post" : { "tags" : [ "Agent" ], "summary" : "Schedule Agent Reassignment", "description" : "Schedules reassignment of tickets, tasks, and automations belonging to a deleted or deactivated agent to another agent within the same department.", "operationId" : "scheduleAgentReassignment", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "agentId", "in" : "path", "required" : true, "description" : "Unique ID of the agent", "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "featureFlags", "in" : "header", "description" : "Feature flags for special cases (e.g., associationV2 for V2 request payload format)", "required" : false, "style" : "simple", "explode" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "associationV2" ] }, "uniqueItems" : true } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "agentReassignment" : { "description" : "Details of agents to whom the associated resources will be reassigned", "$ref" : "#/components/schemas/scheduleReassignmentArray" } }, "required" : [ "agentReassignment" ] }, { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "reassignment" : { "description" : "Details of the agents to whom the org-wide and department-wide resources associated with the agent will be reassigned", "$ref" : "#/components/schemas/scheduleReassignmentV2" } }, "required" : [ "reassignment" ] } ] }, "examples" : { "V1 reassignment (default, no featureFlags header)" : { "value" : { "agentReassignment" : [ { "departmentId" : 19000000012754, "taskNewOwner" : "19000000008734", "ticketNewOwner" : "19000000142005" }, { "departmentId" : 19000000010674, "taskNewOwner" : "19000000008872", "ticketNewOwner" : "19000000182001" }, { "departmentId" : 19000000007073, "taskNewOwner" : "19000000008872", "ticketNewOwner" : "19000000182001" } ] } }, "V2 reassignment with Ticket and Task (featureFlags: associationV2)" : { "value" : { "reassignment" : { "orgWideReassignments" : [ { "key" : "DRE", "newAgentId" : 19000000142005 } ], "deptWideReassignments" : [ { "key" : "Ticket", "departmentVsNewAgent" : [ { "departmentId" : 19000000012754, "newAgentId" : 19000000142005 }, { "departmentId" : 19000000010674, "newAgentId" : 19000000182001 } ] }, { "key" : "Task", "departmentVsNewAgent" : [ { "departmentId" : 19000000012754, "newAgentId" : 19000000008734 } ] } ] } } } } } }, "description" : "V1 payload (agentReassignment array) when featureFlags header is absent; V2 payload (reassignment object) when associationV2 flag is present.", "required" : true }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ] } ] } }, "/api/v1/agentsByIds" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agents by Agent IDs", "description" : "Retrieves details of agents for the specified agent IDs.", "operationId" : "getAgentsByIds", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "agentIds", "in" : "query", "description" : "Comma-separated array of agent IDs.Note: The maximum number of IDs allowed is 50.
", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/getAgentsByIdsResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/agents/{agentId}/photo" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agent Photo", "description" : "Retrieves the profile photo for the specified agent.Note: To get the agent photo, generate an OAuth token for the scope Desk.agents.READ,zohoprofile.userphoto.READ or Desk.basic.READ,zohoprofile.userphoto.READ.
", "operationId" : "getAgentProfilePhoto", "parameters" : [ { "name" : "fileSize", "in" : "query", "description" : "Size of the image file to downloadPossible values: THUMBNAIL, ACTUAL
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "ACTUAL", "THUMBNAIL" ], "default" : "ACTUAL", "maxLength" : 100 } }, { "name" : "agentId", "in" : "path", "required" : true, "description" : "Unique ID of the agent", "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "./Common.json#/components/responses/fileResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/agents/activate" : { "post" : { "tags" : [ "Agent" ], "summary" : "Activate Agents", "description" : "Activates agents in your help desk.", "operationId" : "activateAgents", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "./Department.json#/components/requestBodies/agentIdsArray" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ] } ] } }, "/api/v1/deletedAgents/{agentId}/anonymize" : { "post" : { "tags" : [ "Agent" ], "summary" : "Anonymize Deleted Agent", "description" : "Removes the identification details of a deleted agent.", "operationId" : "anonymizeDeletedAgent", "parameters" : [ { "name" : "agentId", "in" : "path", "required" : true, "description" : "Unique ID of the agent", "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/anonymizeAgentsRequest" }, "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/unprocessableEntityErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ] } ] } }, "/api/v1/agents" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agents", "description" : "Retrieves a particular number of agents based on the specified limit, with pagination support.", "operationId" : "getAgents", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "include", "in" : "query", "description" : "Secondary information related to agentsPossible values: profile, role
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Secondary information related to agents, The allowed values are profile, role. You can include all two values by separating them with commas in the API request.", "items" : { "type" : [ "string" ], "enum" : [ "profile", "role" ] }, "maxItems" : 2, "uniqueItems" : true } }, { "name" : "roleIds", "in" : "query", "description" : "Comma-separated array of role IDsNote: The maximum number of IDs allowed is 50.
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, { "name" : "searchStr", "in" : "query", "description" : "Searches agents by first name, last name, or email ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 1, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" } }, { "name" : "cfSearchStr", "in" : "query", "description" : "Searches agents by custom field", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "minLength" : 1, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" } }, { "name" : "cfFieldName", "in" : "query", "description" : "API name of the custom field used for searching and listing agents", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "pattern" : "cf\\_[A-Za-z0-9\\_]+" } }, { "name" : "fieldName", "in" : "query", "description" : "Field used for searching and listing agentsPossible values: firstName, lastName, name, emailId
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "firstName", "lastName", "emailId", "name" ], "pattern" : "(firstName|lastName|emailId|name)" } }, { "name" : "isLightAgent", "in" : "query", "required" : false, "schema" : { "type" : [ "boolean" ] }, "style" : "form", "explode" : true, "description" : "Indicates whether light or non-light agents must be returnedPossible values: true = light agents, false = non-light agents
" }, { "name" : "sortOrder", "in" : "query", "required" : false, "schema" : { "type" : [ "string" ], "enum" : [ "asc", "desc" ] }, "style" : "form", "explode" : true, "description" : "Sorts the list of agentsPossible values: asc, desc
" }, { "name" : "limit", "in" : "query", "description" : "Number of agents to fetch; default value is 10 and maximum value is 200", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Number of agents to fetch. The default value is 10 and the maximum value supported is 200.", "maximum" : 200, "minimum" : 0, "pattern" : "([0-9]+)" } }, { "name" : "rolePermissionType", "in" : "query", "description" : "Filters agents by role and permission typePossible values: AgentPublic, AgentPersonal, AgentTeamPersonal, Admin, Light, Custom, ${NON_LIGHT}
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "AgentPublic", "AgentPersonal", "AgentTeamPersonal", "Admin", "Custom", "Light" ], "pattern" : "AgentPublic|AgentPersonal|AgentTeamPersonal|Admin|Light|Custom|\\$\\{NON_LIGHT\\}" } }, { "name" : "profileIds", "in" : "query", "description" : "Comma-separated array of profile IDsNote: The maximum number of IDs allowed is 50.
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the deleted agents must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Index number, starting from which the agents must be fetched", "minimum" : 0, "pattern" : "([0-9]+)" } }, { "name" : "isConfirmed", "in" : "query", "description" : "Filters Confirmed & Unconfirmed agents", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean" ], "description" : "Key that denotes if the agents must be confirmed or unconfirmed." } }, { "name" : "departmentIds", "in" : "query", "description" : "Comma-separated array of department IDsNote: The maximum number of IDs allowed is 50.
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, { "name" : "status", "in" : "query", "description" : "Filters agents by activation statusPossible values: ACTIVE, DISABLED, DELETED, IMPORTED
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "description" : "Key that filters agents based on their activation status: ACTIVE, DISABLED, DELETED or IMPORTED", "enum" : [ "ACTIVE", "DISABLED", "DELETED", "IMPORTED" ] } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/agentListArray" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] }, "post" : { "tags" : [ "Agent" ], "summary" : "Create Agent", "description" : "Creates an agent in your help desk.Note: The emailId, lastName, associatedDepartmentIds, and rolePermissionType fields are mandatory in the request. To assign the profile and role for the agent, pass one of the supported rolePermissionType values from the source documentation.
", "operationId" : "addAgent", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/addAgentInputStream" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/agentCFResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.CREATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.CREATE", "Desk.settings.CREATE" ] } ] } }, "/api/v1/myinfo" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get My Information", "description" : "Retrieves details of the currently logged-in agent.", "operationId" : "getMyInfo", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "include", "in" : "query", "description" : "Secondary information related to the agentPossible values: profile, role, associatedDepartments, associatedChatDepartments
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Secondary information related to the agentPossible values: profile, role, associatedDepartments, associatedChatDepartments
", "items" : { "type" : [ "string" ], "enum" : [ "profile", "role", "associatedDepartments", "associatedChatDepartments" ] }, "maxItems" : 4, "uniqueItems" : true } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/getMyInfoResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/agents/{agentId}" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agent", "description" : "Retrieves details of a specific agent.", "operationId" : "getAgent", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "include", "in" : "query", "description" : "Secondary information related to the agentPossible values: profile, role, associatedDepartments, associatedChatDepartments, verifiedEmails
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Secondary information related to the agentPossible values: profile, role, associatedDepartments, associatedChatDepartments, verifiedEmails
", "items" : { "type" : [ "string" ], "enum" : [ "profile", "role", "associatedDepartments", "associatedChatDepartments", "verifiedEmails" ] }, "maxItems" : 5, "uniqueItems" : true } }, { "name" : "agentId", "in" : "path", "required" : true, "description" : "Unique ID of the agent", "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/getAgentResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.READ", "Desk.settings.READ" ] } ] }, "patch" : { "tags" : [ "Agent" ], "summary" : "Update Agent", "description" : "Updates details of an agent.", "operationId" : "updateAgent", "parameters" : [ { "name" : "agentId", "in" : "path", "required" : true, "description" : "Unique ID of the agent", "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateAgent_addAgentInputStream" }, "responses" : { "200" : { "$ref" : "#/components/responses/updateAgentResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ] } ] }, "delete" : { "tags" : [ "Agent" ], "summary" : "Delete Confirmed Agent", "description" : "Deletes a confirmed agent from your help desk.", "operationId" : "deleteAgent", "parameters" : [ { "name" : "agentId", "in" : "path", "required" : true, "description" : "Unique ID of the agent", "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.DELETE", "Desk.basic.DELETE", "Desk.settings.DELETE" ] } ] } }, "/api/v1/agents/{agentId}/deactivate" : { "post" : { "tags" : [ "Agent" ], "summary" : "Deactivate Agent", "description" : "Deactivates an agent in your help desk.", "operationId" : "deactivateAgents", "parameters" : [ { "name" : "agentId", "in" : "path", "required" : true, "description" : "Unique ID of the agent", "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ] } ] } }, "/api/v1/agents/allCounts" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agent Types Counts", "description" : "Retrieves counts for all agent types.", "operationId" : "getAllAgentsCount", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AllAgentsCountResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/deleteMyPhoto" : { "post" : { "tags" : [ "Agent" ], "summary" : "Delete My Photo", "description" : "Deletes the profile photo of the currently logged-in agent.", "operationId" : "deleteMyPhoto", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.UPDATE" ] } ] } }, "/api/v1/agents/deleteUnconfirmed" : { "post" : { "tags" : [ "Agent" ], "summary" : "Delete Unconfirmed Agents", "description" : "Deletes unconfirmed agents from your help desk.", "operationId" : "deleteUnconfirmedAgent", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/deleteUnConfAgentRequest" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.DELETE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.DELETE", "Desk.settings.DELETE" ] } ] } }, "/api/v1/agents/count" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agents Count", "description" : "Retrieves the count of agents filtered by status, confirmation state, and light-agent inclusion.", "operationId" : "getAgentsCount", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "isConfirmed", "in" : "query", "description" : "Filters Confirmed & Unconfirmed agents", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean" ], "description" : "Key that denotes if the agents must be confirmed or unconfirmed." } }, { "name" : "includeLightAgent", "in" : "query", "description" : "Indicates whether light agents must be included in the count", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean" ] } }, { "name" : "status", "in" : "query", "description" : "Parameter that filters agents based on their activation status: ACTIVE or DISABLED", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "description" : "Key that filters agents based on their activation status: ACTIVE, DISABLED, DELETED or IMPORTED", "enum" : [ "ACTIVE", "DISABLED" ] } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/agentCountResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/agents/zuid/{zuid}" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agent by ZUID", "description" : "Retrieves the details of the agent to whom the ZUID belongs.", "operationId" : "getAgentByZuid", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "zuid", "in" : "path", "description" : "Zoho user ID of the agent", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/getAgentByZuidResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/agents/email/{emailId}" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Agent by Email ID", "description" : "Retrieves details of an agent for the specified email ID.", "operationId" : "getAgentByEmail", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "emailId", "in" : "path", "description" : "Email ID of the agent", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([\\w]([\\w\\-\\.\\+\\'\\/]*)@([\\w\\-\\.]*)(\\.[a-zA-Z]{2,22}(\\.[a-zA-Z]{2}){0,2}))" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/getAgentByEmailResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/deletedAgents" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get Deleted Agents", "description" : "Retrieves deleted agents based on the specified limit, with pagination support.", "operationId" : "getDeletedAgents", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Number of agents to fetch; default value is 10 and maximum value is 200", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Number of agents to fetch. The default value is 10 and the maximum value supported is 200.", "maximum" : 200, "minimum" : 0, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the deleted agents must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Index number, starting from which the agents must be fetched", "minimum" : 0, "pattern" : "([0-9]+)" } }, { "name" : "status", "in" : "query", "description" : "Filters deleted agents by statusPossible values: DELETED, ANONYMIZED, CLOSED
", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "description" : "Parameter that filters agents based on their activation status: DELETED or ANONYMIZED or CLOSED", "enum" : [ "DELETED", "ANONYMIZED", "CLOSED" ] } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/deletedAgentsList" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.READ", "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/agents/reinvite" : { "post" : { "tags" : [ "Agent" ], "summary" : "Reinvite Unconfirmed Agents", "description" : "Sends reinvitation mails to unconfirmed agents.", "operationId" : "reInviteAgents", "x-mcp-group" : [ "Users Management" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "./Department.json#/components/requestBodies/reInviteAgents_agentIdsArray" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.agents.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.basic.UPDATE", "Desk.settings.UPDATE" ] } ] } }, "/api/v1/myEntityPreferences" : { "get" : { "tags" : [ "Agent" ], "summary" : "Get My Entity Preferences", "description" : "Retrieves entity preferences of the currently logged-in agent.", "operationId" : "getMyEntityPreference", "parameters" : [ { "name" : "entityType", "in" : "query", "description" : "Entity type of the preference", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "department" ], "pattern" : "department", "maxLength" : 25 } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/myEntityPreferenceResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/unprocessableEntityErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.basic.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] }, "patch" : { "tags" : [ "Agent" ], "summary" : "Update My Entity Preferences", "description" : "Updates entity preferences of the currently logged-in agent.", "operationId" : "updateMyEntityPreference", "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateMyEntityPreferenceInputStream" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.basic.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.UPDATE" ] } ] } } }, "components" : { "schemas" : { "newReassignOwner" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "departmentId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the department" }, "taskNewOwner" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Task new owner" }, "ticketNewOwner" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Ticket new owner" } }, "required" : [ "departmentId", "taskNewOwner", "ticketNewOwner" ] }, "scheduleReassignmentArray" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/newReassignOwner" } }, "agentIdsResponse" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the agent" }, "extn" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Extension number of the agent" }, "roleId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Role ID of the agent" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Mobile number of the agent" }, "emailId" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho user ID of the agent" }, "associatedDepartmentIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the agent photo" }, "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the agent" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Phone number of the agent" }, "profileId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Profile ID of the agent" }, "channelExpert" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true }, "uniqueItems" : false }, "rolePermissionType" : { "type" : [ "string", "null" ], "enum" : [ "AgentPublic", "AgentPersonal", "AgentTeamPersonal", "Admin", "Custom", "Light" ], "description" : "Role permission type of the agent.Possible values: AgentPublic, AgentPersonal, AgentTeamPersonal, Admin, Light, Custom
" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "aboutInfo" : { "type" : [ "string", "null" ], "maxLength" : 65535, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "About information of the agent" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "ACTIVE", "DISABLED", "DELETED", "IMPORTED" ], "description" : "Activation status of the agent.Accepted values: ACTIVE, DISABLED, DELETED, IMPORTED
" }, "isZiaAgent" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a Zia agent or a human agent" } }, "required" : [ "aboutInfo", "associatedDepartmentIds", "channelExpert", "emailId", "extn", "firstName", "id", "isConfirmed", "lastName", "mobile", "phone", "photoURL", "profileId", "roleId", "rolePermissionType", "status", "zuid" ] }, "agentIdsCFResponse" : { "allOf" : [ { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "cf" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } } }, "required" : [ "cf" ] }, { "$ref" : "#/components/schemas/agentIdsResponse" } ] }, "agentIdsResponseArray" : { "type" : [ "array", "null" ], "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/agentIdsResponse" }, { "$ref" : "#/components/schemas/agentIdsCFResponse" } ] } }, "addAgentInputStream" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the agent" }, "extn" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Extension number of the agent" }, "roleId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Role ID of the agent" }, "langCode" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_]*", "description" : "Language code of the agent" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Mobile number of the agent" }, "emailId" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email ID of the agent" }, "associatedChatDepartmentIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "associatedDepartmentIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the agent" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Phone number of the agent" }, "countryCode" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_]*", "description" : "Country code of the agent" }, "profileId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Profile ID of the agent" }, "rolePermissionType" : { "type" : [ "string", "null" ], "enum" : [ "AgentPublic", "AgentPersonal", "AgentTeamPersonal", "Admin", "Custom", "Light" ], "description" : "Role permission type of the agent.Possible values: AgentPublic, AgentPersonal, AgentTeamPersonal, Admin, Light, Custom
" }, "aboutInfo" : { "type" : [ "string", "null" ], "maxLength" : 65535, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "About information of the agent" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "ACTIVE", "DISABLED" ], "description" : "Activation status of the agentPossible values: ACTIVE, DISABLED
" }, "channelExpert" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true }, "uniqueItems" : false, "description" : "Whether the agent is a channel expert" }, "timeZone" : { "type" : [ "string", "null" ], "description" : "Time zone of the agent", "maxLength" : 100 }, "cf" : { "description" : "Custom fields for the agent", "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } } }, "required" : [ "aboutInfo", "associatedChatDepartmentIds", "associatedDepartmentIds", "countryCode", "emailId", "extn", "firstName", "langCode", "lastName", "mobile", "phone", "profileId", "roleId", "rolePermissionType", "status" ] }, "agentInputStream" : { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/addAgentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "channelExpert" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true }, "uniqueItems" : false } }, "required" : [ "channelExpert" ], "additionalProperties" : false } ] }, "agentCFInputStream" : { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "cf" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } } }, "required" : [ "cf" ], "additionalProperties" : false } ] }, "agentResponse" : { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "roleId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Role ID of the agent" }, "profileId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Profile ID of the agent" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" }, "isZiaAgent" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a Zia agent or a human agent" } }, "required" : [ "id", "isConfirmed", "isZiaAgent", "name", "photoURL", "profileId", "roleId", "timeZone", "zuid" ], "additionalProperties" : false } ] }, "agentCFResponse" : { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentCFInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" }, "isZiaAgent" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a Zia agent or a human agent" } }, "required" : [ "id", "isConfirmed", "isZiaAgent", "name", "photoURL", "timeZone", "zuid" ], "additionalProperties" : false } ] }, "agentResponseArray" : { "type" : [ "array", "null" ], "items" : { "anyOf" : [ { "$ref" : "#/components/schemas/agentResponse" }, { "$ref" : "#/components/schemas/agentCFResponse" } ] } }, "myPreferenceInputStrm" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "namePattern" : { "description" : "Pattern that defines how names are displayed", "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "enum" : [ "LAST_NAME", "FIRST_NAME" ] }, "maxItems" : 2, "minItems" : 2, "uniqueItems" : true }, "currentDepartment" : { "description" : "Valid active department ID to which the agent is associated or allDepartment", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "currentDepartment", "namePattern" ] }, "deletedAgentsRespKeys" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "description" : "First name of the agent", "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "lastName" : { "description" : "Last name of the agent", "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "name" : { "description" : "Full name of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "id" : { "description" : "Unique ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "status" : { "description" : "Activation status of the agent", "type" : [ "string", "null" ], "enum" : [ "ACTIVE", "DISABLED", "DELETED", "IMPORTED" ] } }, "required" : [ "firstName", "id", "lastName", "name", "status" ] }, "deletedAgentsRespArray" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/deletedAgentsRespKeys" } }, "agentsObjectForGetAppliedBlueprintDetails" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the agent" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the agent" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "email" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email ID of the agent" } }, "required" : [ "email", "firstName", "id", "lastName", "photoURL" ] }, "profileAgentResponse" : { "type" : [ "object" ], "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "First name of the agent" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Last name of the agent" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "roleId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Role ID of the agent" }, "profileId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Profile ID of the agent" }, "emailId" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$", "description" : "Email ID of the agent" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" }, "aboutInfo" : { "type" : [ "string", "null" ], "maxLength" : 65535, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "About information of the agent" }, "associatedDepartmentIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "channelExpert" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true }, "uniqueItems" : true }, "extn" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Extension number of the agent" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Mobile number of the agent" }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|^$", "description" : "Phone number of the agent" }, "rolePermissionType" : { "type" : [ "string", "null" ], "enum" : [ "AgentPublic", "AgentPersonal", "AgentTeamPersonal", "Admin", "Custom", "Light" ], "description" : "Role permission type of the agent.Possible values: AgentPublic, AgentPersonal, AgentTeamPersonal, Admin, Light, Custom
" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "ACTIVE", "DISABLED" ], "description" : "Activation status of the agentPossible values: ACTIVE, DISABLED
" }, "isConfirmed" : { "type" : [ "boolean" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" } }, "required" : [ "emailId", "firstName", "id", "lastName", "photoURL", "profileId", "roleId", "zuid" ], "additionalProperties" : false }, "myEntityPreferenceInputArr" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/myEntityPreferenceInputStream" } }, "myEntityPreferenceInputStream" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "entityType" : { "description" : "Entity type of the preference", "type" : [ "string" ], "enum" : [ "department" ] }, "entityId" : { "description" : "Unique ID of the entity", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "^(?:[0-9]+|-1)$" }, "propName" : { "description" : "Name of the preference property", "type" : [ "string" ], "enum" : [ "isNotificationEnabled" ], "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "propValue" : { "description" : "Value of the preference property", "type" : [ "string" ], "enum" : [ "ENABLED", "DISABLED" ], "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "required" : [ "entityType", "entityId", "propName", "propValue" ] }, "createAgentPermission" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "profileId" : { "description" : "Profile ID of the agent", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "roleId" : { "description" : "Role ID of the agent", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } } }, "createAgentPayload" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "lastName" : { "description" : "Last name of the agent", "type" : [ "string" ], "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "langCode" : { "description" : "Language code of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[a-zA-Z_]*" }, "emailId" : { "description" : "Email ID of the agent", "type" : [ "string" ], "maxLength" : 100, "x-unique" : true, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$" }, "associatedChatDepartmentIds" : { "description" : "Chat departments with which the agent is associated", "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "associatedDepartmentIds" : { "description" : "Departments with which the agent is associated", "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "firstName" : { "description" : "First name of the agent", "type" : [ "string" ], "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "countryCode" : { "description" : "Country code of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[a-zA-Z_]*" }, "extn" : { "description" : "Extension number of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\s]+" }, "mobile" : { "description" : "Mobile number of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\s]+" }, "phone" : { "description" : "Phone number of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\s]+" }, "rolePermissionType" : { "description" : "Role permission type of the agent", "type" : [ "string" ], "enum" : [ "AgentPublic", "AgentPersonal", "AgentTeamPersonal", "Admin", "Custom", "Light" ] }, "status" : { "description" : "Activation status of the agentPossible values: ACTIVE, DISABLED
", "type" : [ "string" ], "enum" : [ "ACTIVE", "DISABLED" ] }, "aboutInfo" : { "description" : "About information of the agent", "type" : [ "string" ], "maxLength" : 255, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "channelExpert" : { "type" : [ "array", "null" ], "description" : "Channels handled by the agent", "items" : { "type" : [ "string" ] }, "maxItems" : 51 }, "timeZone" : { "type" : [ "string", "null" ], "description" : "Time zone of the agent", "pattern" : "[a-zA-Z_/\\-\\+0-9]*" }, "cf" : { "type" : [ "object" ], "description" : "User-defined fields related to agents", "patternProperties" : { "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" : { "type" : [ "string", "number", "boolean", "null" ], "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" } } } }, "required" : [ "associatedDepartmentIds", "emailId", "lastName", "rolePermissionType" ] }, "myEntityPreferenceInputArrRequest" : { "type" : [ "array" ], "items" : { "$ref" : "#/components/schemas/myEntityPreferenceInputStream" }, "minItems" : 1, "maxItems" : 100 }, "orgWideAssociationKey" : { "type" : "string", "enum" : [ "Assist", "ZohoBooks", "BUG", "CHAT", "CLIQ", "ZohoCRM", "DRE", "ZohoInvoice", "ZOHO REPORTS", "Asterisk1.4", "twilio", "Connector", "JIRA", "MSBot", "MSOffice" ], "description" : "Org-wide association declaration key" }, "deptWideAssociationKey" : { "type" : "string", "enum" : [ "Ticket", "Task", "Automation" ], "description" : "Dept-wide association declaration key" }, "orgWideReassignment" : { "type" : "object", "additionalProperties" : false, "properties" : { "key" : { "$ref" : "#/components/schemas/orgWideAssociationKey" }, "newAgentId" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "New owner of the resources associated with the agent; null removes the assignment only for modules that support unassignment (e.g. Ticket); other modules require a replacement owner." } }, "required" : [ "key" ] }, "deptWideReassignment" : { "type" : "object", "additionalProperties" : false, "properties" : { "key" : { "$ref" : "#/components/schemas/deptWideAssociationKey" }, "departmentVsNewAgent" : { "type" : "array", "description" : "New owners of the resources per department", "items" : { "$ref" : "#/components/schemas/departmentVsNewAgentEntry" } } }, "required" : [ "key", "departmentVsNewAgent" ] }, "departmentVsNewAgentEntry" : { "type" : "object", "additionalProperties" : false, "properties" : { "departmentId" : { "type" : "integer", "format" : "int64", "description" : "ID of the department to which the new resource owner belongs" }, "newAgentId" : { "type" : [ "integer", "null" ], "format" : "int64", "description" : "New owner of the resources associated with the agent in this department; null removes the assignment only for modules that support unassignment (e.g. Ticket); other modules require a replacement owner." } }, "required" : [ "departmentId" ] }, "scheduleReassignmentV2" : { "type" : "object", "additionalProperties" : false, "properties" : { "orgWideReassignments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/orgWideReassignment" }, "description" : "Details of agents to whom the org-wide resources associated with the agent will be reassigned" }, "deptWideReassignments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/deptWideReassignment" }, "description" : "Details of agents to whom the department-wide resources associated with the agent will be reassigned" } } } }, "responses" : { "myPhotoResponse" : { "description" : "myPhotoResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" } }, "required" : [ "photoURL" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000056007/photo?orgId=123456" } } } } } }, "getAgentsByIdsResponse" : { "description" : "getAgentsByIdsResponse template definitions", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "./Department.json#/components/schemas/agentData" } }, "required" : [ "data" ] }, { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/agentIdsResponseArray" } }, "required" : [ "data" ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "firstName" : "", "lastName" : "case", "photoURL" : null, "roleId" : "7000000012324", "profileId" : "7000000012339", "emailId" : "case@zylker.com", "id" : "1892000000056007", "zuid" : "437793" }, { "firstName" : "", "lastName" : "jade", "photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=123456", "roleId" : "7000000012324", "profileId" : "7000000012339", "emailId" : "jade@zylker.com", "id" : "1892000000042001", "zuid" : "279392" }, { "firstName" : "Steve", "lastName" : "Waugh", "photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000888059/photo?orgId=123456", "roleId" : "70000000127346", "profileId" : "70000000120834", "emailId" : "stephen@zylker.com", "id" : "1892000000888059", "zuid" : "91723912" } ] } } } } } }, "agentCFResponse" : { "description" : "agentCFResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentCFInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "timeZone", "zuid" ], "additionalProperties" : false } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "lastName" : "Walsh", "extn" : "", "roleId" : "1892000000056099", "langCode" : "fr_FR", "mobile" : "", "timeZone" : "Pacific/Majuro", "emailId" : "marisol51@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : "", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069" ], "firstName" : "Marisol", "photoURL" : null, "phone" : "", "profileId" : "1892000000056091", "countryCode" : "en_US", "channelExpert" : [ ], "name" : "Walsh Marisol", "rolePermissionType" : "Admin", "isConfirmed" : true, "aboutInfo" : "", "id" : "1892000000056007", "status" : "ACTIVE", "isZiaAgent" : false } } } } } }, "getMyInfoResponse" : { "description" : "getMyInfoResponse template definitions", "content" : { "application/json" : { "schema" : { "allOf" : [ { "type" : [ "object" ], "properties" : { "associatedChatDepartments" : { "type" : [ "array", "null" ], "items" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "sanitizedName" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Sanitized name of the chat department of the chat department" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Name of the chat department" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the chat department" } }, "required" : [ "id", "name", "sanitizedName" ] }, "uniqueItems" : false }, "role" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Name of the role" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" } }, "required" : [ "id", "name" ] }, "profile" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Full name of the agent" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" } }, "required" : [ "id", "name" ] }, "associatedDepartments" : { "type" : [ "array", "null" ], "items" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "sanitizedName" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Sanitized name of the chat department" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Full name of the agent" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" } }, "required" : [ "id", "name", "sanitizedName" ] }, "uniqueItems" : false } }, "additionalProperties" : false }, { "anyOf" : [ { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "roleId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Role ID of the agent" }, "profileId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Profile ID of the agent" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" }, "isZiaAgent" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a Zia agent or a human agent" } }, "required" : [ "id", "isConfirmed", "isZiaAgent", "name", "photoURL", "profileId", "roleId", "timeZone", "zuid" ], "additionalProperties" : false } ] }, { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentCFInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" }, "isZiaAgent" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a Zia agent or a human agent" } }, "required" : [ "id", "isConfirmed", "isZiaAgent", "name", "photoURL", "timeZone", "zuid" ], "additionalProperties" : false } ] } ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "associatedChatDepartments" : [ { "sanitizedName" : "Developement", "name" : "Developement", "id" : "1892000000006907" } ], "lastName" : "Emard", "extn" : "", "role" : { "name" : "CEO", "id" : "1892000000056099" }, "langCode" : "fr_FR", "emailId" : "emardtorrey@zylker.com", "photoURL" : null, "countryCode" : "en_US", "isConfirmed" : true, "id" : "1892000000056007", "roleId" : "1892000000056099", "profile" : { "name" : "Administrator", "id" : "1892000000056091" }, "mobile" : "", "timeZone" : "Pacific/Majuro", "associatedChatDepartmentIds" : [ "1892000000006907" ], "zuid" : "10687231", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069" ], "associatedDepartments" : [ { "sanitizedName" : "Developement", "name" : "Developement", "id" : "1892000000006907" }, { "sanitizedName" : "r-d", "name" : "R & D", "id" : "1892000000082069" } ], "firstName" : "Torrey", "phone" : "", "profileId" : "1892000000056091", "channelExpert" : [ "Facebook", "Chat", "Phone", "Twitter", "Web", "Email", "Forums" ], "name" : "Torrey Emard", "rolePermissionType" : "Admin", "aboutInfo" : "Expert in handling tickets and Automations", "status" : "ACTIVE", "isZiaAgent" : false } } } } } }, "updateAgentResponse" : { "description" : "updateAgentResponse template definitions", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentCFInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "timeZone", "zuid" ], "additionalProperties" : false } ] }, { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "roleId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Role ID of the agent" }, "profileId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Profile ID of the agent" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "profileId", "roleId", "timeZone", "zuid" ], "additionalProperties" : false } ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "lastName" : "Marisol Walsh", "extn" : "3298", "roleId" : "1892000000056099", "langCode" : "fr_FR", "mobile" : "", "timeZone" : "Pacific/Majuro", "emailId" : "marisol51@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : "10687231", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069" ], "firstName" : "K", "photoURL" : null, "phone" : "+1 5550100123", "profileId" : "1892000000056091", "countryCode" : "en_US", "channelExpert" : [ "Facebook", "Email", "Forums" ], "name" : "K Marisol Walsh", "rolePermissionType" : "Admin", "isConfirmed" : true, "aboutInfo" : "Expert in handling Reports", "id" : "1892000000056007", "status" : "ACTIVE", "isZiaAgent" : false } } } } } }, "AllAgentsCountResponse" : { "description" : "AllAgentsCountResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "lightAgents" : { "description" : "Number of light agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "importedAgents" : { "description" : "Number of imported agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "deactivatedAgents" : { "description" : "Number of deactivated agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "closedAgents" : { "description" : "Number of closed agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "allAgents" : { "description" : "Total number of agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "activeAgents" : { "description" : "Number of active agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "unconfirmedAgents" : { "description" : "Number of unconfirmed agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "deletedAgents" : { "description" : "Number of deleted agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "activeZiaAgents" : { "description" : "Number of active Zia agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "deactivatedZiaAgents" : { "description" : "Number of deactivated Zia agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "allZiaAgents" : { "description" : "Total number of Zia agents", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "activeAgents", "activeZiaAgents", "allAgents", "allZiaAgents", "closedAgents", "deactivatedAgents", "deactivatedZiaAgents", "deletedAgents", "importedAgents", "lightAgents", "unconfirmedAgents" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "lightAgents" : 2, "importedAgents" : 2, "deactivatedAgents" : 5, "closedAgents" : 0, "allAgents" : 18, "activeAgents" : 8, "unconfirmedAgents" : 3, "deletedAgents" : 8, "activeZiaAgents" : 3, "deactivatedZiaAgents" : 1, "allZiaAgents" : 4 } } } } } }, "myPreference" : { "description" : "myPreference template definitions", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/myPreferenceInputStrm" }, { "type" : [ "object", "null" ], "properties" : { "a11y_epilepsy" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of epilepsy persona" }, "ui_displayLayout" : { "type" : [ "string", "null" ], "enum" : [ "smartFocus", "focusedWidth", "fullWidth" ], "description" : "App layout optimized for the screen resolution" }, "activitiesView" : { "type" : [ "string", "null" ], "enum" : [ "LIST", "LIST_COMPACT", "TABLE" ], "description" : "Activities view" }, "a11y_readingMask" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of the reading mask" }, "a11y_successNotifcationAutoCloseTime" : { "type" : [ "string", "null" ], "enum" : [ "01", "03", "05", "10", "15", "20" ], "description" : "Success notification auto-close time" }, "a11y_readingMaskHeight" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "\\b([1-9][0-9]|90)\\b", "description" : "Reading mask height" }, "datePattern" : { "description" : "Date pattern", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "yyyy[\\-\\/\\.]MM[\\-\\/\\.]dd|MM[\\-\\/\\.]dd[\\-\\/\\.]yyyy|dd[\\-\\/\\.]MM[\\-\\/\\.]yyyy" }, "a11Y_animationControls" : { "type" : [ "string", "null" ], "enum" : [ "regularmotion", "reducedmotion", "autoReducedmotion" ], "description" : "Animation control setting" }, "a11y_astigmatism" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of astigmatism persona" }, "loginLandingPage" : { "description" : "Default home page shown on login", "type" : [ "string", "null" ], "enum" : [ "LISTVIEW", "HQ", "FEEDS", "VIEWS_DUEDATE", "VIEWS_CRM", "VIEWS_STATUS", "VIEWS_PRIORITY", "REPORTS_OVERVIEW", "REPORTS_DASHBOARDS", "REPORTS", "MYPROFILE", "TASKS", "ARTICLE_DASHBOARD", "SOLUTIONS", "ACCOUNTS", "CONTACTS", "COMMUNITY", "CHAT", "SOCIALS", "ACTIVITIES", "CALLS", "EVENTS", "IM" ] }, "ui_appFontFamily" : { "type" : [ "string", "null" ], "enum" : [ "Zoho Puvi", "Lato", "Roboto", "Vazirmatn", "OpenDyslexic", "Poppins" ], "description" : "App font family" }, "loadGettingStartedPage" : { "description" : "Status of loading the getting started page", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "a11y_errorNotificationAutoCloseTime" : { "type" : [ "string", "null" ], "enum" : [ "01", "03", "05", "10", "15", "20" ], "description" : "Error notification auto-close time" }, "ui_tagColorVariant" : { "type" : [ "string", "null" ], "enum" : [ "bold", "subtle", "minimal" ], "description" : "Tag color variant" }, "authtokenDeprecationBanner" : { "type" : [ "string", "null" ], "enum" : [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9" ], "description" : "Authtoken deprecation banner status" }, "invoicePreferencesContacts" : { "type" : [ "string", "null" ], "enum" : [ "" ], "description" : "Accepted values: " }, "core_contractsDvIbarPanelView" : { "type" : [ "string", "null" ], "enum" : [ "collapse", "expand" ], "description" : "Contracts detail view ibar panel view" }, "imNotification" : { "type" : [ "string", "null" ], "enum" : [ "ENABLED", "DISABLED" ], "description" : "Accepted values: ENABLED, DISABLED" }, "core_tasksTableViewContentStyle" : { "type" : [ "string", "null" ], "enum" : [ "wrap", "clip" ], "description" : "Tasks table view content style" }, "pinAllTickets" : { "description" : "Status of pinning tickets", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "newClient" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of the new react client app" }, "pinAllContacts" : { "description" : "Status of pinning contacts", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "a11y_customCursor" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of custom cursor" }, "ui_themes" : { "type" : [ "string", "null" ], "enum" : [ "red", "green", "blue", "yellow", "orange", "pink", "skyBlue", "teal" ], "description" : "App theme" }, "pinAllDashboards" : { "description" : "Status of pinning dashboards", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "pinAllReports" : { "description" : "Status of pinning reports", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "extncontactrightpanel" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of extension right panel collapse for contacts" }, "ui_lhsTheme" : { "type" : [ "string", "null" ], "enum" : [ "light", "dark" ], "description" : "Left panel appearance" }, "articleAutoSuggestion" : { "description" : "Status of article suggestions while replying to tickets", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "keyBoardShortcuts" : { "description" : "Status of keyboard shortcuts", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "a11y_adhdFriendly" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of ADHD-friendly persona" }, "collapseSidePanel" : { "description" : "Status of side panel collapse", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "communityListViewMode" : { "type" : [ "string", "null" ], "enum" : [ "CLASSIC", "COMPACT" ], "description" : "Community topic list view mode" }, "a11y_isSuccessNotificationAutoClose" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of success notification auto-close" }, "core_dviBarTabWidth" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^(\\d{1,2}(\\.\\d{1,2})?|100|357)$", "description" : "Width for the detail view ibarTab" }, "core_callsDvIbarPanelView" : { "type" : [ "string", "null" ], "enum" : [ "collapse", "expand" ], "description" : "Calls detail view ibar panel view" }, "core_contactsTableViewContentStyle" : { "type" : [ "string", "null" ], "enum" : [ "wrap", "clip" ], "description" : "Contacts table view content style" }, "invoicePreferencesCases" : { "type" : [ "string", "null" ], "enum" : [ "" ], "description" : "Accepted values: " }, "ui_appearance" : { "type" : [ "string", "null" ], "enum" : [ "light", "dark", "auto", "pureDark" ], "description" : "App appearance" }, "a11y_visuallyImpaired" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of visually-impaired persona" }, "a11y_highlightClick" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of clickable area highlighting" }, "ui_appFontSize" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "\\b(8|9|1[0-9]|20|21|22|23|24)\\b", "description" : "App font size" }, "extnaccountrightpanel" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of extension right panel collapse for accounts" }, "a11y_customCursorSize" : { "type" : [ "string", "null" ], "enum" : [ "8", "16", "24", "32" ], "description" : "Custom cursor size" }, "deskDatePattern" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "yyyy[\\/\\-\\.\\s]MM[\\/\\-\\.\\s]dd|MM[\\/\\-\\.\\s]dd[\\/\\-\\.\\s]yyyy|dd[\\/\\-\\.\\s]MM[\\/\\-\\.\\s]yyyy|yyyy[\\/\\-\\.\\s]MMM[\\/\\-\\.\\s]dd|MMM[\\/\\-\\.\\s]dd[\\/\\-\\.\\s]yyyy|dd[\\/\\-\\.\\s]MMM[\\/\\-\\.\\s]yyyy|dd[\\/\\-\\.\\s]MMMM[\\/\\-\\.\\s]yyyy|MMMM[\\/\\-\\.\\s]dd[\\/\\-\\.\\s]yyyy|yyyy[\\/\\-\\.\\s]MMMM[\\/\\-\\.\\s]dd|dd[\\/\\-\\.\\s]MM[\\/\\-\\.\\s]yy|MM[\\/\\-\\.\\s]dd[\\/\\-\\.\\s]yy|yy[\\/\\-\\.\\s]MM[\\/\\-\\.\\s]dd|dd[\\/\\-\\.\\s]MMM[\\/\\-\\.\\s]yy|MMM[\\/\\-\\.\\s]dd[\\/\\-\\.\\s]yy|yy[\\/\\-\\.\\s]MMM[\\/\\-\\.\\s]dd|dd[\\/\\-\\.\\s]MMMM[\\/\\-\\.\\s]yy|MMMM[\\/\\-\\.\\s]dd[\\/\\-\\.\\s]yy|yy[\\/\\-\\.\\s]MMMM[\\/\\-\\.\\s]dd|", "description" : "Pattern that defines which date format is stored in Desk" }, "a11y_seizureSafe" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of seizure-safe persona" }, "core_ticketsTableViewContentStyle" : { "type" : [ "string", "null" ], "enum" : [ "wrap", "clip" ], "description" : "Tickets table view content style" }, "outBoxDelayTime" : { "description" : "Outbox delay time", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([1-9][0-9]?|100)S|([1-5][0-9]?|60)M" }, "a11y_dyslexia" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of dyslexia persona" }, "ticketConversationView" : { "description" : "Status of viewing threads and comments together", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "ui_pureDarkMode" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of pure dark mode" }, "a11y_isFontSizeAdaptToZoom" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of adapting app font size to zoom" }, "core_ticketReplyActionsOrder" : { "type" : [ "string", "null" ], "enum" : [ "forward_replyAll_reply", "forward_reply_replyAll", "replyAll_forward_reply", "replyAll_reply_forward", "reply_forward_replyAll", "reply_replyAll_forward" ], "description" : "Ticket reply action dropdown order" }, "a11y_contrastLevel" : { "type" : [ "string", "null" ], "enum" : [ "low", "medium", "high" ], "description" : "App contrast level" }, "a11y_blindness" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of blindness persona" }, "a11y_motorDisabilities" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of motor-disabilities persona" }, "tasksView" : { "type" : [ "string", "null" ], "enum" : [ "LIST", "LIST_COMPACT", "TABLE" ], "description" : "Tasks view" }, "a11y_focusRing" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of focus ring" }, "hideCurrentYearDate" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of current year date pattern display" }, "core_contactsDvIbarPanelView" : { "type" : [ "string", "null" ], "enum" : [ "collapse", "expand" ], "description" : "Contacts detail view ibar panel view" }, "core_editorFontFamily" : { "type" : [ "string", "null" ], "enum" : [ "Lato", "Roboto", "Zoho Puvi", "Arial", "Carlito", "Helvetica", "Verdana", "Wide", "Courier New", "Comic Sans MS", "Garamond", "Georgia", "Narrow", "Serif", "Tahoma", "Times New Roman", "MotoyaLMaru", "Trebuchet", "Mulish", "Vazirmatn", "OpenDyslexic", "Poppins" ], "description" : "Editor font family" }, "defaultSendBehavior" : { "description" : "Default send behavior for tickets", "type" : [ "string", "null" ], "enum" : [ "Send", "Send and Close" ] }, "a11y_customCursorColor" : { "type" : [ "string", "null" ], "enum" : [ "black", "white" ], "description" : "Custom cursor color" }, "core_accountsDvIbarPanelView" : { "type" : [ "string", "null" ], "enum" : [ "collapse", "expand" ], "description" : "Accounts detail view ibar panel view" }, "ui_displayLayoutWidth" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "\\b([5-8][9]|[5-8][0-9])\\b", "description" : "App layout width" }, "core_needEmptyQueueColumn" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of the empty queue column" }, "communityTopicsRecordsPerPage" : { "type" : [ "string", "null" ], "enum" : [ "10", "20", "30", "40", "50" ], "description" : "Number of community topics listed on a page" }, "reportDurationFormat" : { "type" : [ "string", "null" ], "enum" : [ "HH:MM:SS", "YEAR" ], "description" : "Duration format used for report fields" }, "a11y_needAccessibilityShortCutInWms" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of accessibility shortcut in WMS" }, "a11y_notificationView" : { "type" : [ "string", "null" ], "enum" : [ "stack", "list" ], "description" : "Notification view" }, "core_tasksDvIbarPanelView" : { "type" : [ "string", "null" ], "enum" : [ "collapse", "expand" ], "description" : "Tasks detail view ibar panel view" }, "imStatus" : { "type" : [ "string", "null" ], "enum" : [ "ONLINE", "OFFLINE" ], "description" : "Accepted values: ONLINE, OFFLINE" }, "a11y_zoomLevel" : { "type" : [ "string", "null" ], "enum" : [ "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24" ], "description" : "App zoom level" }, "core_accountsTableViewContentStyle" : { "type" : [ "string", "null" ], "enum" : [ "wrap", "clip" ], "description" : "Accounts table view content style" }, "callsView" : { "type" : [ "string", "null" ], "enum" : [ "LIST", "LIST_COMPACT", "TABLE" ], "description" : "Calls view" }, "a11y_criticalLink" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of critical link highlighting" }, "pinAllAccounts" : { "description" : "Status of pinning accounts", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "contactsView" : { "description" : "Contact view", "type" : [ "string", "null" ], "enum" : [ "LIST", "GRID" ] }, "a11y_isContrastRatioAdaptForBg" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of automatic contrast ratio adaptation for backgrounds" }, "accountsView" : { "description" : "Account view", "type" : [ "string", "null" ], "enum" : [ "LIST", "GRID" ] }, "a11y_underlineLink" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of underlined links" }, "communityTopicsSortBy" : { "type" : [ "string", "null" ], "enum" : [ "createdTime", "modifiedTime" ], "description" : "Sort field of community topics" }, "a11y_contrast" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of increased contrast" }, "ticketsView" : { "description" : "Ticket view", "type" : [ "string", "null" ], "enum" : [ "LIST", "LIST_COMPACT", "TABLE", "STATUS_QUEUE", "CRM_QUEUE", "DUEDATE_QUEUE", "PRIORITY_QUEUE" ] }, "extnticketrightpanel" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of extension right panel collapse for tickets" }, "outBoxDelay" : { "description" : "Status of outbox delay", "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ] }, "core_ticketsDvIbarPanelView" : { "type" : [ "string", "null" ], "enum" : [ "collapse", "expand" ], "description" : "Tickets detail view ibar panel view" }, "a11y_customScroll" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of custom scroll" }, "a11y_readingMaskWidth" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "\\b(10[0-9]|100|[1-9][0-9])\\b", "description" : "Reading mask width" }, "ui_isTagTextDefaultColor" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of using default tag text color" }, "a11y_focusRingEnabledPlaces" : { "type" : [ "string", "null" ], "enum" : [ "all", "main" ], "description" : "Places where focus ring is enabled" }, "tempForceRedirection" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Accepted values: DISABLED, ENABLED" }, "core_ticketReplyActions" : { "type" : [ "string", "null" ], "enum" : [ "reply", "replyAll", "forward", "reply_replyAll", "reply_forward", "replyAll_forward", "replyAll_reply", "forward_reply", "forward_replyAll", "forward_replyAll_reply", "forward_reply_replyAll", "replyAll_forward_reply", "replyAll_reply_forward", "reply_forward_replyAll", "reply_replyAll_forward" ], "description" : "Ticket reply action buttons" }, "communityTopicsSortOrder" : { "type" : [ "string", "null" ], "enum" : [ "ascending", "descending" ], "description" : "Sort order of community topics" }, "core_contractsTableViewContentStyle" : { "type" : [ "string", "null" ], "enum" : [ "wrap", "clip" ], "description" : "Contracts table view content style" }, "core_callsTableViewContentStyle" : { "type" : [ "string", "null" ], "enum" : [ "wrap", "clip" ], "description" : "Calls table view content style" }, "core_eventsTableViewContentStyle" : { "type" : [ "string", "null" ], "enum" : [ "wrap", "clip" ], "description" : "Events table view content style" }, "invoicePreferencesAccounts" : { "type" : [ "string", "null" ], "enum" : [ "" ], "description" : "Accepted values: " }, "a11y_readingMaskOpacity" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^0?\\.([2-9][0-9]?|1[5-9])$", "description" : "Reading mask opacity" }, "a11y_isErrorNotificationAutoClose" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of error notification auto-close" }, "core_isTicketReplySendAndUpdateStatus" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of ticket reply send and update status" }, "eventsView" : { "type" : [ "string", "null" ], "enum" : [ "LIST", "LIST_COMPACT", "TABLE" ], "description" : "Events view" }, "a11y_readingMaskLevel" : { "type" : [ "string", "null" ], "enum" : [ "small", "medium", "full", "custom" ], "description" : "Reading mask level" }, "a11y_colorBlindness" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of color-blindness persona" }, "core_isPublicComment" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of public comments" }, "a11y_elderly" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of elderly persona" }, "timeFormat" : { "description" : "Time format", "type" : [ "string", "null" ], "enum" : [ "12-hour", "24-hour" ] }, "core_eventsDvIbarPanelView" : { "type" : [ "string", "null" ], "enum" : [ "collapse", "expand" ], "description" : "Events detail view ibar panel view" }, "core_editorFontSize" : { "type" : [ "string", "null" ], "enum" : [ "8", "10", "12", "14", "18", "24", "36" ], "description" : "Editor font size" }, "feedNotificationFilterPreference" : { "type" : [ "string", "null" ], "enum" : [ "all", "unread", "flagged", "mentions" ], "description" : "Feeds notification filter preference" }, "core_conversationNestedViewLineStyle" : { "type" : [ "string", "null" ], "enum" : [ "curved", "straight" ], "description" : "Line style for nested conversation view" }, "module_visibilityType" : { "type" : [ "string", "null" ], "enum" : [ "topBand", "unifiedLHS" ], "description" : "Module visibility type" }, "core_conversationNestedViewShowIcons" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of icon display in nested conversation view" }, "core_conversationViewType" : { "type" : [ "string", "null" ], "enum" : [ "recentTop", "recentBottom", "nestedView" ], "description" : "Conversation subtab view type" }, "core_threadCommentViewType" : { "type" : [ "string", "null" ], "enum" : [ "recentTop", "recentBottom" ], "description" : "Threads and comments subtab view type" }, "essp_displayContext" : { "type" : [ "string", "null" ], "enum" : [ "inApp", "newTab" ], "description" : "Employee portal display context" }, "essp_displayMode" : { "type" : [ "string", "null" ], "enum" : [ "compactView", "splitView", "fullScreenView" ], "description" : "Employee portal display mode" }, "a11y_isSearchKeywordHighlighted" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of search keyword highlighting" }, "a11y_isHighlightedSearchKeywordProminent" : { "type" : [ "string", "null" ], "enum" : [ "DISABLED", "ENABLED" ], "description" : "Status of prominent highlighted search keyword" }, "a11y_mandatoryFieldIndication" : { "type" : [ "string", "null" ], "enum" : [ "asterisk", "requiredText" ], "description" : "Mandatory field indication" }, "a11y_mandatoryFieldLabelColor" : { "type" : [ "string", "null" ], "enum" : [ "default", "red" ], "description" : "Mandatory field label color" }, "a11y_colorFilter" : { "type" : [ "string", "null" ], "enum" : [ "none", "grayscale" ], "description" : "Color filter" }, "a11y_grayScaleFilterExcludedPlaces" : { "type" : [ "string", "null" ], "enum" : [ "none", "richText_richTextEditor" ], "description" : "Places excluded from grayscale filter" } }, "required" : [ "a11Y_animationControls", "a11y_adhdFriendly", "a11y_astigmatism", "a11y_blindness", "a11y_colorBlindness", "a11y_contrast", "a11y_contrastLevel", "a11y_criticalLink", "a11y_customCursor", "a11y_customCursorColor", "a11y_customCursorSize", "a11y_customScroll", "a11y_dyslexia", "a11y_elderly", "a11y_epilepsy", "a11y_errorNotificationAutoCloseTime", "a11y_focusRing", "a11y_focusRingEnabledPlaces", "a11y_highlightClick", "a11y_isContrastRatioAdaptForBg", "a11y_isErrorNotificationAutoClose", "a11y_isFontSizeAdaptToZoom", "a11y_isSuccessNotificationAutoClose", "a11y_motorDisabilities", "a11y_needAccessibilityShortCutInWms", "a11y_notificationView", "a11y_readingMask", "a11y_readingMaskHeight", "a11y_readingMaskLevel", "a11y_readingMaskOpacity", "a11y_readingMaskWidth", "a11y_seizureSafe", "a11y_successNotifcationAutoCloseTime", "a11y_underlineLink", "a11y_visuallyImpaired", "a11y_zoomLevel", "accountsView", "activitiesView", "articleAutoSuggestion", "authtokenDeprecationBanner", "callsView", "collapseSidePanel", "communityListViewMode", "communityTopicsRecordsPerPage", "communityTopicsSortBy", "communityTopicsSortOrder", "contactsView", "core_accountsDvIbarPanelView", "core_accountsTableViewContentStyle", "core_callsDvIbarPanelView", "core_callsTableViewContentStyle", "core_contactsDvIbarPanelView", "core_contactsTableViewContentStyle", "core_contractsDvIbarPanelView", "core_contractsTableViewContentStyle", "core_dviBarTabWidth", "core_editorFontFamily", "core_editorFontSize", "core_eventsDvIbarPanelView", "core_eventsTableViewContentStyle", "core_isPublicComment", "core_isTicketReplySendAndUpdateStatus", "core_needEmptyQueueColumn", "core_tasksDvIbarPanelView", "core_tasksTableViewContentStyle", "core_ticketReplyActions", "core_ticketReplyActionsOrder", "core_ticketsDvIbarPanelView", "core_ticketsTableViewContentStyle", "datePattern", "defaultSendBehavior", "deskDatePattern", "eventsView", "extnaccountrightpanel", "extncontactrightpanel", "extnticketrightpanel", "feedNotificationFilterPreference", "hideCurrentYearDate", "imNotification", "imStatus", "invoicePreferencesAccounts", "invoicePreferencesCases", "invoicePreferencesContacts", "keyBoardShortcuts", "loadGettingStartedPage", "loginLandingPage", "newClient", "outBoxDelay", "outBoxDelayTime", "pinAllAccounts", "pinAllContacts", "pinAllDashboards", "pinAllReports", "pinAllTickets", "reportDurationFormat", "tasksView", "tempForceRedirection", "ticketConversationView", "ticketsView", "timeFormat", "ui_appFontFamily", "ui_appFontSize", "ui_appearance", "ui_displayLayout", "ui_displayLayoutWidth", "ui_isTagTextDefaultColor", "ui_lhsTheme", "ui_pureDarkMode", "ui_tagColorVariant", "ui_themes", "core_conversationNestedViewLineStyle", "module_visibilityType", "core_conversationNestedViewShowIcons", "core_conversationViewType", "core_threadCommentViewType", "essp_displayContext", "essp_displayMode", "a11y_isSearchKeywordHighlighted", "a11y_isHighlightedSearchKeywordProminent", "a11y_mandatoryFieldIndication", "a11y_mandatoryFieldLabelColor", "a11y_colorFilter", "a11y_grayScaleFilterExcludedPlaces" ], "additionalProperties" : false } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "namePattern" : [ "FIRST_NAME", "LAST_NAME" ], "articleAutoSuggestion" : "ENABLED", "keyBoardShortcuts" : "ENABLED", "pinAllAccounts" : "ENABLED", "outBoxDelayTime" : "60S", "collapseSidePanel" : "DISABLED", "pinAllTickets" : "ENABLED", "ticketConversationView" : "ENABLED", "contactsView" : "LIST", "accountsView" : "LIST", "pinAllContacts" : "ENABLED", "ticketsView" : "DUEDATE_QUEUE", "datePattern" : "dd/MM/yyyy", "defaultSendBehavior" : "Send", "currentDepartment" : "allDepartment", "timeFormat" : "12-hour", "outBoxDelay" : "DISABLED", "pinAllDashboards" : "DISABLED", "loginLandingPage" : "LISTVIEW", "loadGettingStartedPage" : "DISABLED", "pinAllReports" : "ENABLED" } } } } } }, "getAgentResponse" : { "description" : "getAgentResponse template definitions", "content" : { "application/json" : { "schema" : { "allOf" : [ { "type" : [ "object" ], "properties" : { "associatedChatDepartments" : { "type" : [ "array", "null" ], "items" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "sanitizedName" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Sanitized name of the chat department" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Full name of the department" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the department" } }, "required" : [ "id", "name", "sanitizedName" ] }, "uniqueItems" : false }, "role" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 10, "minProperties" : 10, "properties" : { "isDefault" : { "type" : [ "boolean", "null" ], "description" : "Whether this is the default role" }, "shareDataWithPeers" : { "type" : [ "boolean", "null" ], "description" : "Whether share data with peers" }, "immediateSubRoles" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "encId" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Encrypted ID" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Name of the role" }, "description" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Description" }, "adminRole" : { "type" : [ "boolean", "null" ], "description" : "Whether admin role" }, "reportsTo" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the role this role reports to" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the role" }, "isVisible" : { "type" : [ "boolean", "null" ], "description" : "Whether visible" } }, "required" : [ "adminRole", "description", "encId", "id", "immediateSubRoles", "isDefault", "isVisible", "name", "reportsTo", "shareDataWithPeers" ] }, "verifiedEmails" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$" }, "uniqueItems" : false }, "profile" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 21, "minProperties" : 21, "properties" : { "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Timestamp when this record was last modified (epoch milliseconds)" }, "visible" : { "type" : [ "boolean", "null" ], "description" : "Whether visible" }, "allowedTabs" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "defaultProfile" : { "type" : [ "boolean", "null" ], "description" : "Whether default profile" }, "allowedPermissionNames" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ] }, "uniqueItems" : false }, "type" : { "type" : [ "string", "null" ], "enum" : [ "ADMIN", "STANDARD", "LIGHT", "CUSTOM", "PORTAL" ], "description" : "Accepted values: ADMIN, STANDARD, LIGHT, CUSTOM, PORTAL" }, "invisibleTabs" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "portalProfile" : { "type" : [ "boolean", "null" ], "description" : "Whether portal profile" }, "prohibitedPermissionNames" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ] }, "uniqueItems" : false }, "allowedPermissions" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "profileDesc" : { "type" : [ "string", "null" ], "maxLength" : 32000, "minLength" : 0, "description" : "Description of the profile" }, "createdBy" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the user who created this record" }, "lightAgentProfile" : { "type" : [ "boolean", "null" ], "description" : "Whether light agent profile" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "description" : "Full name of the profile" }, "visibleTabs" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Timestamp when this record was created (epoch milliseconds)" }, "modifiedBy" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the user who last modified this record" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the profile" }, "category" : { "type" : [ "boolean", "null" ], "description" : "Category" }, "prohibitedPermisisons" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "adminProfile" : { "type" : [ "boolean", "null" ], "description" : "Whether admin profile" } }, "required" : [ "adminProfile", "allowedPermissionNames", "allowedPermissions", "allowedTabs", "category", "createdBy", "createdTime", "defaultProfile", "id", "invisibleTabs", "lightAgentProfile", "modifiedBy", "modifiedTime", "name", "portalProfile", "profileDesc", "prohibitedPermisisons", "prohibitedPermissionNames", "type", "visible", "visibleTabs" ] }, "associatedDepartments" : { "type" : [ "array", "null" ], "items" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 18, "minProperties" : 18, "properties" : { "chatStatusId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the chat status" }, "chatStatus" : { "type" : [ "string", "null" ], "enum" : [ "AVAILABLE", "DISABLED", "NOT_CREATED" ], "description" : "Status of chat department.Accepted values: AVAILABLE, DISABLED, NOT_CREATED
" }, "isAssignToTeamEnabled" : { "type" : [ "boolean", "null" ], "description" : "Whether is assign to team enabled" }, "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Timestamp when this record was last modified (epoch milliseconds)" }, "hasLogo" : { "type" : [ "boolean", "null" ], "description" : "Whether has logo" }, "sanitizedName" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Sanitized name of the chat department" }, "sanitizedDeptHash" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Sanitized dept hash" }, "isVisibleInCustomerPortal" : { "type" : [ "boolean", "null" ], "description" : "Whether visible in the customer portal" }, "creatorId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the creator" }, "description" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Description" }, "associatedAgentIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "isDefault" : { "type" : [ "boolean", "null" ], "description" : "Whether this is the default" }, "isEnabled" : { "type" : [ "boolean", "null" ], "description" : "Whether enabled" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Full name of the agent" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))", "description" : "Timestamp when this record was created (epoch milliseconds)" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the department" }, "nameInCustomerPortal" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Name shown in the customer portal" }, "status" : { "type" : [ "string", "null" ], "enum" : [ "0", "1", "2" ], "description" : "Accepted values: 0, 1, 2" } }, "required" : [ "associatedAgentIds", "chatStatus", "chatStatusId", "createdTime", "creatorId", "description", "hasLogo", "id", "isAssignToTeamEnabled", "isDefault", "isEnabled", "isVisibleInCustomerPortal", "modifiedTime", "name", "nameInCustomerPortal", "sanitizedDeptHash", "sanitizedName", "status" ] }, "uniqueItems" : false } }, "additionalProperties" : false }, { "anyOf" : [ { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentCFInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "timeZone", "zuid" ], "additionalProperties" : false } ] }, { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "URL of the image file displaying the agent's photo" }, "roleId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Role ID of the agent" }, "profileId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Profile ID of the agent" }, "name" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Full name of the agent" }, "timeZone" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "description" : "Time zone of the agent" }, "isConfirmed" : { "type" : [ "boolean", "null" ], "description" : "Indicates whether the agent is a confirmed user in the portal.Possible values: true = confirmed, false = unconfirmed
" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the agent" }, "zuid" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Zoho User ID of the agent" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "profileId", "roleId", "timeZone", "zuid" ], "additionalProperties" : false } ] } ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "associatedChatDepartments" : [ { "name" : "Developement", "id" : "1892000000006907" } ], "lastName" : "case", "extn" : "3298", "role" : { "name" : "CEO", "id" : "1892000000056099" }, "langCode" : "fr_FR", "emailId" : "case@zylker.com", "photoURL" : null, "countryCode" : "en_US", "isConfirmed" : true, "id" : "1892000000056096", "roleId" : "1892000000056099", "profile" : { "name" : "Administrator", "id" : "1892000000056091" }, "mobile" : "", "timeZone" : "Pacific/Majuro", "associatedChatDepartmentIds" : [ "1892000000006907" ], "zuid" : "10687231", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069" ], "associatedDepartments" : [ { "name" : "Developement", "id" : "1892000000006907" }, { "name" : "R & D", "id" : "1892000000082069" } ], "firstName" : "", "phone" : "+1 5550100123", "profileId" : "1892000000056091", "channelExpert" : [ "Facebook", "Chat", "Phone", "Twitter", "Web", "Email", "Forums" ], "name" : "case", "rolePermissionType" : "Admin", "aboutInfo" : "Expert in handling tickets and Automations", "status" : "ACTIVE", "isZiaAgent" : false } } } } } }, "agentCountResponse" : { "description" : "agentCountResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "count" : { "description" : "Number of agents that match the filter", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "count" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "count" : 5 } } } } } }, "getAgentByZuidResponse" : { "description" : "getAgentByZuidResponse template definitions", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentCFInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "description" : "URL of the agent photo", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "name" : { "description" : "Full name of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "timeZone" : { "description" : "Time zone of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*" }, "isConfirmed" : { "description" : "Indicates whether the agent is a confirmed user in the portal", "type" : [ "boolean", "null" ] }, "id" : { "description" : "Unique ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "zuid" : { "description" : "Zoho user ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "timeZone", "zuid" ], "additionalProperties" : false } ] }, { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "description" : "URL of the agent photo", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "roleId" : { "description" : "Role ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "profileId" : { "description" : "Profile ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "name" : { "description" : "Full name of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "timeZone" : { "description" : "Time zone of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*" }, "isConfirmed" : { "description" : "Indicates whether the agent is a confirmed user in the portal", "type" : [ "boolean", "null" ] }, "id" : { "description" : "Unique ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "zuid" : { "description" : "Zoho user ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "profileId", "roleId", "timeZone", "zuid" ], "additionalProperties" : false } ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "lastName" : "case", "extn" : "3298", "roleId" : "1892000000056099", "langCode" : "fr_FR", "mobile" : "", "timeZone" : "Pacific/Majuro", "emailId" : "case@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : "10687231", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069", "1892000000639717" ], "firstName" : "", "photoURL" : null, "phone" : "+1 5550100123", "profileId" : "1892000000056091", "countryCode" : "en_US", "channelExpert" : [ "Facebook" ], "name" : "case", "rolePermissionType" : "Admin", "isConfirmed" : true, "aboutInfo" : "Expert in handling tickets and Automations", "id" : "1892000000056007", "status" : "ACTIVE", "isZiaAgent" : false } } } } } }, "getAgentByEmailResponse" : { "description" : "getAgentByEmailResponse template definitions", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentCFInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "description" : "URL of the agent photo", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "name" : { "description" : "Full name of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "timeZone" : { "description" : "Time zone of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*" }, "isConfirmed" : { "description" : "Indicates whether the agent is a confirmed user in the portal", "type" : [ "boolean", "null" ] }, "id" : { "description" : "Unique ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "zuid" : { "description" : "Zoho user ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "timeZone", "zuid" ], "additionalProperties" : false } ] }, { "type" : "object", "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/agentInputStream" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "description" : "URL of the agent photo", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "roleId" : { "description" : "Role ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "profileId" : { "description" : "Profile ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "name" : { "description" : "Full name of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "timeZone" : { "description" : "Time zone of the agent", "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "[a-zA-Z_/\\-\\+0-9]*" }, "isConfirmed" : { "description" : "Indicates whether the agent is a confirmed user in the portal", "type" : [ "boolean", "null" ] }, "id" : { "description" : "Unique ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "zuid" : { "description" : "Zoho user ID of the agent", "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "id", "isConfirmed", "name", "photoURL", "profileId", "roleId", "timeZone", "zuid" ], "additionalProperties" : false } ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "lastName" : "case", "extn" : "3298", "roleId" : "1892000000056099", "langCode" : "fr_FR", "mobile" : "", "timeZone" : "Pacific/Majuro", "emailId" : "case@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : "10687231", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069", "1892000000639717" ], "firstName" : "", "photoURL" : null, "phone" : "+1 5550100123", "profileId" : "1892000000056091", "countryCode" : "en_US", "channelExpert" : [ "Facebook", "Chat", "Phone", "Twitter", "Web", "Email", "Forums" ], "name" : "case", "rolePermissionType" : "Admin", "isConfirmed" : true, "aboutInfo" : "Expert in handling Tasks and Automations", "id" : "1892000000056007", "status" : "ACTIVE", "isZiaAgent" : false } } } } } }, "deletedAgentsList" : { "description" : "deletedAgentsList template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/deletedAgentsRespArray" } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "firstName" : "John", "lastName" : "volk", "name" : "John volk", "id" : "1892000000888059", "status" : "CLOSED" }, { "firstName" : "jade", "lastName" : "var", "name" : "jade var", "id" : "1892000000888059", "status" : "ANONYMIZED" }, { "firstName" : "Steve", "lastName" : "Waugh", "name" : "Steve Waugh", "id" : "1892000000888059", "status" : "DELETED" } ] } } } } } }, "agentListArray" : { "description" : "agentListArray template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/agentResponseArray" } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "lastName" : "case", "extn" : "3298", "roleId" : "1892000000056099", "langCode" : "en_US", "mobile" : "", "emailId" : "case@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : "10687231", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069", "1892000000639717" ], "firstName" : "", "photoURL" : null, "phone" : "12121", "profileId" : "1892000000056091", "countryCode" : "en_US", "channelExpert" : [ "Facebook", "Chat", "Phone", "Twitter", "Web", "Email", "Forums" ], "name" : "case", "isConfirmed" : true, "aboutInfo" : "Expert in handling tickets and Automations", "id" : "1892000000056007", "status" : "ACTIVE", "isZiaAgent" : false }, { "lastName" : "jade", "extn" : "3203", "roleId" : "1892000000056899", "langCode" : "en_US", "mobile" : "", "emailId" : "jade@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : "10657727", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069", "1892000000639717", "1892000001019041", "1892000001106673", "1892000001109673" ], "firstName" : "", "photoURL" : "https://desk.zoho.com/api/v1/agents/1892000000042001/photo?orgId=123456", "phone" : "", "profileId" : "1892000000056091", "countryCode" : "en_US", "channelExpert" : [ "Facebook", "Email", "Forums" ], "name" : "jade", "isConfirmed" : true, "aboutInfo" : "Expert in handling tickets", "id" : "1892000000042001", "status" : "ACTIVE", "isZiaAgent" : false }, { "lastName" : "john", "extn" : "3228", "roleId" : "1892000000056004", "langCode" : "en_US", "mobile" : "", "emailId" : "john@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : "10713988", "associatedDepartmentIds" : [ "1892000000006907", "1892000001019041" ], "firstName" : "", "photoURL" : null, "phone" : "+1 5550100123", "profileId" : "18920000000232043", "countryCode" : "en_US", "channelExpert" : [ "Facebook", "Chat", "Phone", "Twitter", "Web", "Email", "Forums" ], "name" : "john", "isConfirmed" : true, "aboutInfo" : "Expert in handling tickets and Automations", "id" : "1892000000070001", "status" : "DISABLED" }, { "lastName" : "Waugh", "extn" : "4020", "roleId" : "1892000000056004", "langCode" : "ja_JP", "mobile" : "", "emailId" : "stephen@zylker.com", "associatedChatDepartmentIds" : [ ], "zuid" : null, "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069", "1892000000639717" ], "firstName" : "Steve", "photoURL" : null, "phone" : "", "profileId" : "18920000000232043", "countryCode" : "en_US", "channelExpert" : [ "Facebook", "Chat" ], "name" : "Steve Waugh", "isConfirmed" : false, "aboutInfo" : "Expert in handling Departments", "id" : "1892000000888059", "status" : "ACTIVE", "isZiaAgent" : false } ] } } } } } }, "myEntityPreferenceResponse" : { "description" : "myEntityPreferenceResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "description" : "Entity preferences of the current agent", "$ref" : "#/components/schemas/myEntityPreferenceInputArr" } }, "required" : [ "data" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "data" : [ { "entityType" : "department", "entityId" : "1892000000082069", "propName" : "isNotificationEnabled", "propValue" : "ENABLED" }, { "entityType" : "department", "entityId" : "1892000000082070", "propName" : "isNotificationEnabled", "propValue" : "DISABLED" } ] } } } } } } }, "requestBodies" : { "myPreferenceInputStrm" : { "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : [ "string", "boolean", "integer" ] }, "maxProperties" : 25, "properties" : { "namePattern" : { "description" : "Pattern that defines how names are displayed", "type" : [ "array", "null" ], "items" : { "type" : [ "string", "null" ], "enum" : [ "LAST_NAME", "FIRST_NAME" ], "maxLength" : 100, "minLength" : 0 }, "maxItems" : 2, "minItems" : 2, "uniqueItems" : true }, "currentDepartment" : { "description" : "Valid active department ID to which the agent is associated or allDepartment", "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "allDepartment|[0-9]+" }, "essp_displayContext" : { "description" : "Employee portal display context", "type" : [ "string", "null" ], "enum" : [ "inApp", "newTab" ], "maxLength" : 100 }, "essp_displayMode" : { "description" : "Employee portal display mode", "type" : [ "string", "null" ], "enum" : [ "compactView", "splitView", "fullScreenView" ], "maxLength" : 100 }, "deskDatePattern" : { "description" : "Pattern that defines which date format is stored in Desk", "type" : [ "string", "null" ], "pattern" : "(yyyy\\/MM\\/dd|yyyy-MM-dd|yyyy.MM.dd|yyyy\\sMM\\sdd|MM\\/dd\\/yyyy|MM-dd-yyyy|MM.dd.yyyy|MM\\sdd\\syyyy|dd\\/MM\\/yyyy|dd-MM-yyyy|dd.MM.yyyy|dd\\sMM\\syyyy|yyyy\\/MMM\\/dd|yyyy-MMMdd|yyyy.MMM.dd|yyyy\\sMMM\\sdd|MMM\\/dd\\/yyyy|MMM-dd-yyyy|MMM.dd.yyyy|MMM\\sdd\\syyyy|dd\\/MMM\\/yyyy|dd-MMM-yyyy|dd.MMM.yyyy|dd\\sMMM\\syyyy|dd\\/MMMM\\/yyyy|dd-MMMM-yyyy|dd.MMMM.yyyy|dd\\sMMMM\\syyyy|MMMM\\/dd\\/yyyy|MMMM-dd-yyyy|MMMM.dd.yyyy|MMMM\\sdd\\syyyy|yyyy\\/MMMM\\/dd|yyyy-MMMM-dd|yyyy.MMMM.dd|yyyy\\sMMMM\\sdd|dd\\/MM\\/yy|dd-MM-yy|dd.MM.yy|dd\\sMM\\syy|MM\\/dd\\/yy|MM-dd-yy|MM.dd.yy|MM\\sdd\\syy|yy\\/MM\\/dd|yy-MM-dd|yy.MM.dd|yy\\sMM\\sdd|dd\\/MMM\\/yy|dd-MMM-yy|dd.MMM.yy|dd\\sMMM\\syy|MMM\\/dd\\/yy|MMM-dd-yy|MMM.dd.yy|MMM\\sdd\\syy|yy\\/MMM\\/dd|yy-MMM-dd|yy.MMM.dd|yy\\sMMM\\sdd|dd\\/MMMM\\/yy|dd-MMMM-yy|dd.MMMM.yy|dd\\sMMMM\\syy|MMMM\\/dd\\/yy|MMMM-dd-yy|MMMM.dd.yy|MMMM\\sdd\\syy|yy\\/MMMM\\/dd|yy-MMMM-dd|yy.MMMM.dd|yy\\sMMMM\\sdd|\\s)" }, "articleAutoSuggestion" : { "description" : "Status of article suggestions while replying to tickets", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "keyBoardShortcuts" : { "description" : "Status of keyboard shortcuts", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "collapseSidePanel" : { "description" : "Status of side panel collapse", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "extnticketrightpanel" : { "description" : "Status of extension right panel collapse for tickets", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "extncontactrightpanel" : { "description" : "Status of extension right panel collapse for contacts", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "extnaccountrightpanel" : { "description" : "Status of extension right panel collapse for accounts", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "hideCurrentYearDate" : { "description" : "Status of current year date pattern display", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "pinAllAccounts" : { "description" : "Status of pinning accounts", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "pinAllTickets" : { "description" : "Status of pinning tickets", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "pinAllContacts" : { "description" : "Status of pinning contacts", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "ticketConversationView" : { "description" : "Status of viewing threads and comments together", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "pinAllReports" : { "description" : "Status of pinning reports", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "pinAllDashboards" : { "description" : "Status of pinning dashboards", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "loadGettingStartedPage" : { "description" : "Status of loading the getting started page", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "contactsView" : { "description" : "Contact view", "type" : [ "string", "null" ], "pattern" : "LIST|GRID|TABLE" }, "accountsView" : { "description" : "Account view", "type" : [ "string", "null" ], "pattern" : "LIST|GRID|TABLE" }, "ticketsView" : { "description" : "Ticket view", "type" : [ "string", "null" ], "pattern" : "LIST|LIST_COMPACT|TABLE|STATUS_QUEUE|CRM_QUEUE|DUEDATE_QUEUE|PRIORITY_QUEUE" }, "tasksView" : { "description" : "Tasks view", "type" : [ "string", "null" ], "pattern" : "LIST|LIST_COMPACT|TABLE" }, "callsView" : { "description" : "Calls view", "type" : [ "string", "null" ], "pattern" : "LIST|LIST_COMPACT|TABLE" }, "eventsView" : { "description" : "Events view", "type" : [ "string", "null" ], "pattern" : "LIST|LIST_COMPACT|TABLE" }, "activitiesView" : { "description" : "Activities view", "type" : [ "string", "null" ], "pattern" : "LIST|LIST_COMPACT|TABLE" }, "defaultSendBehavior" : { "description" : "Default send behavior for tickets", "type" : [ "string", "null" ], "pattern" : "Send|Send and Close" }, "loginLandingPage" : { "description" : "Default home page shown on login", "type" : [ "string", "null" ], "pattern" : "EVENTS|CALLS|ACTIVITIES|SOCIALS|CHAT|LISTVIEW|HQ|FEEDS|VIEWS_DUEDATE|VIEWS_CRM|VIEWS_STATUS|VIEWS_PRIORITY|REPORTS_OVERVIEW|REPORTS_DASHBOARDS|REPORTS|MYPROFILE|TASKS|ARTICLE_DASHBOARD|SOLUTIONS|ACCOUNTS|CONTACTS|COMMUNITY|IM" }, "timeFormat" : { "description" : "Time format", "type" : [ "string", "null" ], "pattern" : "12-hour|24-hour" }, "newClient" : { "description" : "Status of the new react client app", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "authtokenDeprecationBanner" : { "description" : "Authtoken deprecation banner status", "type" : [ "string", "null" ], "pattern" : "[0-9]" }, "outBoxDelay" : { "description" : "Status of outbox delay", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "outBoxDelayTime" : { "description" : "Outbox delay time", "type" : [ "string", "null" ], "pattern" : "([1-9][0-9]?|100)S|([1-5][0-9]?|60)M" }, "reportDurationFormat" : { "description" : "Duration format used for report fields", "type" : [ "string", "null" ], "pattern" : "HH:MM:SS|YEAR" }, "ui_appearance" : { "description" : "App appearance", "type" : [ "string", "null" ], "pattern" : "light|dark|auto|pureDark" }, "ui_lhsTheme" : { "description" : "Left panel appearance", "type" : [ "string", "null" ], "pattern" : "light|dark" }, "ui_pureDarkMode" : { "description" : "Status of pure dark mode", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "ui_themes" : { "description" : "App theme", "type" : [ "string", "null" ], "pattern" : "red|green|blue|yellow|orange|pink|skyBlue|teal" }, "ui_displayLayout" : { "description" : "App layout optimized for the screen resolution", "type" : [ "string", "null" ], "pattern" : "smartFocus|focusedWidth|fullWidth" }, "ui_displayLayoutWidth" : { "description" : "App layout width", "type" : [ "string", "null" ], "pattern" : "\\b([5-8][9]|[5-8][0-9])\\b" }, "ui_appFontFamily" : { "description" : "App font family", "type" : [ "string", "null" ], "pattern" : "Zoho Puvi|Lato|Roboto|Vazirmatn|OpenDyslexic|Poppins" }, "ui_appFontSize" : { "description" : "App font size", "type" : [ "string", "null" ], "pattern" : "\\b(8|9|1[0-9]|20|21|22|23|24)\\b" }, "core_editorFontFamily" : { "description" : "Editor font family", "type" : [ "string", "null" ], "pattern" : "Lato|Roboto|Zoho Puvi|Arial|Carlito|Helvetica|Verdana|Wide|Courier New|Comic Sans MS|Garamond|Georgia|Narrow|Serif|Tahoma|Times New Roman|MotoyaLMaru|Trebuchet|Mulish|Vazirmatn|OpenDyslexic|Poppins" }, "core_editorFontSize" : { "description" : "Editor font size", "type" : [ "string", "null" ], "pattern" : "8|10|12|14|18|24|36" }, "core_isPublicComment" : { "description" : "Status of public comments", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_criticalLink" : { "description" : "Status of critical link highlighting", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_underlineLink" : { "description" : "Status of underlined links", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_highlightClick" : { "description" : "Status of clickable area highlighting", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11Y_animationControls" : { "description" : "Animation control setting", "type" : [ "string", "null" ], "pattern" : "regularmotion|reducedmotion|autoReducedmotion" }, "a11y_customScroll" : { "description" : "Status of custom scroll", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_zoomLevel" : { "description" : "App zoom level", "type" : [ "string", "null" ], "pattern" : "\\b(8|9|1[0-9]|20|21|22|23|24)\\b" }, "a11y_isFontSizeAdaptToZoom" : { "description" : "Status of adapting app font size to zoom", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_needAccessibilityShortCutInWms" : { "description" : "Status of accessibility shortcut in WMS", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_contrast" : { "description" : "Status of increased contrast", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_contrastLevel" : { "description" : "App contrast level", "type" : [ "string", "null" ], "pattern" : "low|medium|high" }, "a11y_isContrastRatioAdaptForBg" : { "description" : "Status of automatic contrast ratio adaptation for backgrounds", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_readingMask" : { "description" : "Status of the reading mask", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_readingMaskLevel" : { "description" : "Reading mask level", "type" : [ "string", "null" ], "pattern" : "small|medium|full|custom" }, "a11y_readingMaskHeight" : { "description" : "Reading mask height", "type" : [ "string", "null" ], "pattern" : "\\b([1-9][0-9]|90)\\b" }, "a11y_readingMaskWidth" : { "description" : "Reading mask width", "type" : [ "string", "null" ], "pattern" : "\\b(10[0-9]|100|[1-9][0-9])\\b" }, "a11y_readingMaskOpacity" : { "description" : "Reading mask opacity", "type" : [ "string", "null" ], "pattern" : "^0?\\.([2-9][0-9]?|1[5-9])$" }, "core_ticketReplyActions" : { "description" : "Ticket reply action buttons", "type" : [ "string", "null" ], "pattern" : "reply|replyAll|forward|reply_replyAll|reply_forward|replyAll_forward|replyAll_reply|forward_reply|forward_replyAll|forward_replyAll_reply|forward_reply_replyAll|replyAll_forward_reply|replyAll_reply_forward|reply_forward_replyAll|reply_replyAll_forward" }, "core_ticketReplyActionsOrder" : { "description" : "Ticket reply action dropdown order", "type" : [ "string", "null" ], "pattern" : "forward_replyAll_reply|forward_reply_replyAll|replyAll_forward_reply|replyAll_reply_forward|reply_forward_replyAll|reply_replyAll_forward" }, "core_needEmptyQueueColumn" : { "description" : "Status of the empty queue column", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "communityListViewMode" : { "description" : "Community topic list view mode", "type" : [ "string", "null" ], "pattern" : "CLASSIC|COMPACT" }, "communityTopicsSortOrder" : { "description" : "Sort order of community topics", "type" : [ "string", "null" ], "pattern" : "ascending|descending" }, "communityTopicsSortBy" : { "description" : "Sort field of community topics", "type" : [ "string", "null" ], "pattern" : "createdTime|modifiedTime" }, "communityTopicsRecordsPerPage" : { "description" : "Number of community topics listed on a page", "type" : [ "string", "null" ], "pattern" : "\\b(10|20|30|40|50)\\b" }, "core_dviBarTabWidth" : { "description" : "Width for the detail view ibarTab", "type" : [ "string", "null" ], "pattern" : "^(\\d{1,2}(\\.\\d{1,2})?|100|357)$" }, "a11y_focusRing" : { "description" : "Status of focus ring", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_focusRingEnabledPlaces" : { "description" : "Places where focus ring is enabled", "type" : [ "string", "null" ], "pattern" : "all|main" }, "a11y_notificationView" : { "description" : "Notification view", "type" : [ "string", "null" ], "pattern" : "stack|list" }, "a11y_isSuccessNotificationAutoClose" : { "description" : "Status of success notification auto-close", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_successNotifcationAutoCloseTime" : { "description" : "Success notification auto-close time", "type" : [ "string", "null" ], "pattern" : "01|03|05|10|15|20" }, "a11y_isErrorNotificationAutoClose" : { "description" : "Status of error notification auto-close", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_errorNotificationAutoCloseTime" : { "description" : "Error notification auto-close time", "type" : [ "string", "null" ], "pattern" : "01|03|05|10|15|20" }, "a11y_customCursor" : { "description" : "Status of custom cursor", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_customCursorSize" : { "description" : "Custom cursor size", "type" : [ "string", "null" ], "pattern" : "8|16|24|32" }, "a11y_customCursorColor" : { "description" : "Custom cursor color", "type" : [ "string", "null" ], "pattern" : "black|white" }, "a11y_adhdFriendly" : { "description" : "Status of ADHD-friendly persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_astigmatism" : { "description" : "Status of astigmatism persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_blindness" : { "description" : "Status of blindness persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_colorBlindness" : { "description" : "Status of color-blindness persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_dyslexia" : { "description" : "Status of dyslexia persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_epilepsy" : { "description" : "Status of epilepsy persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_elderly" : { "description" : "Status of elderly persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_motorDisabilities" : { "description" : "Status of motor-disabilities persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_seizureSafe" : { "description" : "Status of seizure-safe persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_visuallyImpaired" : { "description" : "Status of visually-impaired persona", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "core_ticketsDvIbarPanelView" : { "description" : "Tickets detail view ibar panel view", "type" : [ "string", "null" ], "pattern" : "collapse|expand" }, "core_contactsDvIbarPanelView" : { "description" : "Contacts detail view ibar panel view", "type" : [ "string", "null" ], "pattern" : "collapse|expand" }, "core_accountsDvIbarPanelView" : { "description" : "Accounts detail view ibar panel view", "type" : [ "string", "null" ], "pattern" : "collapse|expand" }, "core_contractsDvIbarPanelView" : { "description" : "Contracts detail view ibar panel view", "type" : [ "string", "null" ], "pattern" : "collapse|expand" }, "core_callsDvIbarPanelView" : { "description" : "Calls detail view ibar panel view", "type" : [ "string", "null" ], "pattern" : "collapse|expand" }, "core_tasksDvIbarPanelView" : { "description" : "Tasks detail view ibar panel view", "type" : [ "string", "null" ], "pattern" : "collapse|expand" }, "core_eventsDvIbarPanelView" : { "description" : "Events detail view ibar panel view", "type" : [ "string", "null" ], "pattern" : "collapse|expand" }, "core_isTicketReplySendAndUpdateStatus" : { "description" : "Status of ticket reply send and update status", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "ui_tagColorVariant" : { "description" : "Tag color variant", "type" : [ "string", "null" ], "pattern" : "bold|subtle|minimal" }, "ui_isTagTextDefaultColor" : { "description" : "Status of using default tag text color", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "core_ticketsTableViewContentStyle" : { "description" : "Tickets table view content style", "type" : [ "string", "null" ], "pattern" : "wrap|clip" }, "core_contactsTableViewContentStyle" : { "description" : "Contacts table view content style", "type" : [ "string", "null" ], "pattern" : "wrap|clip" }, "core_accountsTableViewContentStyle" : { "description" : "Accounts table view content style", "type" : [ "string", "null" ], "pattern" : "wrap|clip" }, "core_contractsTableViewContentStyle" : { "description" : "Contracts table view content style", "type" : [ "string", "null" ], "pattern" : "wrap|clip" }, "core_callsTableViewContentStyle" : { "description" : "Calls table view content style", "type" : [ "string", "null" ], "pattern" : "wrap|clip" }, "core_tasksTableViewContentStyle" : { "description" : "Tasks table view content style", "type" : [ "string", "null" ], "pattern" : "wrap|clip" }, "core_eventsTableViewContentStyle" : { "description" : "Events table view content style", "type" : [ "string", "null" ], "pattern" : "wrap|clip" }, "a11y_strikeThroughDisabledButton" : { "description" : "Status of strike-through for disabled buttons", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_switchLabel" : { "description" : "Status of switch label", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "feedNotificationFilterPreference" : { "description" : "Feeds notification filter preference", "type" : [ "string", "null" ], "pattern" : "all|unread|flagged|mentions" }, "core_conversationNestedViewLineStyle" : { "description" : "Line style for nested conversation view", "type" : [ "string", "null" ], "pattern" : "curved|straight" }, "core_conversationNestedViewShowIcons" : { "description" : "Status of icon display in nested conversation view", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "core_conversationViewType" : { "description" : "Conversation subtab view type", "type" : [ "string", "null" ], "pattern" : "recentTop|recentBottom|nestedView" }, "core_threadCommentViewType" : { "description" : "Threads and comments subtab view type", "type" : [ "string", "null" ], "pattern" : "recentTop|recentBottom" }, "a11y_isSearchKeywordHighlighted" : { "description" : "Status of search keyword highlighting", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_isHighlightedSearchKeywordProminent" : { "description" : "Status of prominent highlighted search keyword", "type" : [ "string", "null" ], "pattern" : "ENABLED|DISABLED" }, "a11y_mandatoryFieldIndication" : { "description" : "Mandatory field indication", "type" : [ "string", "null" ], "pattern" : "asterisk|requiredText" }, "a11y_mandatoryFieldLabelColor" : { "description" : "Mandatory field label color", "type" : [ "string", "null" ], "pattern" : "default|red" }, "a11y_colorFilter" : { "description" : "Color filter", "type" : [ "string", "null" ], "pattern" : "none|grayscale" }, "a11y_grayScaleFilterExcludedPlaces" : { "description" : "Places excluded from grayscale filter", "type" : [ "string", "null" ], "pattern" : "none|richText_richTextEditor" }, "module_visibilityType" : { "description" : "Module visibility type", "type" : [ "string", "null" ], "pattern" : "topBand|unifiedLHS" } } }, "examples" : { "Valid requestBody Definitions" : { "value" : { "namePattern" : [ "LAST_NAME", "FIRST_NAME" ], "articleAutoSuggestion" : "ENABLED", "keyBoardShortcuts" : "ENABLED", "pinAllAccounts" : "ENABLED", "outBoxDelayTime" : "60S", "collapseSidePanel" : "DISABLED", "pinAllTickets" : "ENABLED", "ticketConversationView" : "ENABLED", "contactsView" : "LIST", "accountsView" : "LIST", "pinAllContacts" : "ENABLED", "ticketsView" : "STATUS_QUEUE", "defaultSendBehavior" : "Send", "datePattern" : "dd/MM/yyyy", "currentDepartment" : "1892000000082069", "timeFormat" : "12-hour", "outBoxDelay" : "DISABLED", "pinAllDashboards" : "DISABLED", "loginLandingPage" : "LISTVIEW", "loadGettingStartedPage" : "DISABLED", "pinAllReports" : "ENABLED" } } } } } }, "anonymizeAgentsRequest" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "anonymizedName" : { "description" : "Nickname of the agent that appears on the entity history page", "type" : [ "string" ], "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" } } }, "examples" : { "Valid requestBody Definitions" : { "value" : { "anonymizedName" : "Anonyme" } } } } } }, "addAgentInputStream" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "allOf" : [ { "$ref" : "#/components/schemas/createAgentPermission" }, { "$ref" : "#/components/schemas/createAgentPayload" }, { "properties" : { "rolePermissionType" : { "type" : [ "string" ], "enum" : [ "Custom" ], "description" : "Accepted values: Custom" } } } ] }, { "allOf" : [ { "$ref" : "#/components/schemas/createAgentPermission" }, { "$ref" : "#/components/schemas/createAgentPayload" }, { "properties" : { "rolePermissionType" : { "not" : { "const" : "Custom" } } }, "not" : { "required" : [ "roleId" ] } } ] }, { "allOf" : [ { "$ref" : "#/components/schemas/createAgentPermission" }, { "$ref" : "#/components/schemas/createAgentPayload" }, { "properties" : { "rolePermissionType" : { "not" : { "const" : "Custom" } } }, "not" : { "required" : [ "profileId" ] } } ] } ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "lastName" : "Walsh", "firstName" : "Marisol", "countryCode" : "en_US", "langCode" : "fr_FR", "rolePermissionType" : "Admin", "emailId" : "marisol51@zylker.com", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069" ] } } } } } }, "updateAgent_addAgentInputStream" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "lastName" : { "description" : "Last name of the agent", "type" : [ "string" ], "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "extn" : { "description" : "Extension number of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\s]+" }, "roleId" : { "description" : "Role ID of the agent", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "langCode" : { "description" : "Language code of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[a-zA-Z_]*" }, "mobile" : { "description" : "Mobile number of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\s]+" }, "emailId" : { "description" : "Email ID of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$" }, "associatedChatDepartmentIds" : { "description" : "Chat departments with which the agent is associated", "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "associatedDepartmentIds" : { "description" : "Departments with which the agent is associated", "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "firstName" : { "description" : "First name of the agent", "type" : [ "string" ], "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "phone" : { "description" : "Phone number of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\s]+" }, "countryCode" : { "description" : "Country code of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[a-zA-Z_]*" }, "profileId" : { "description" : "Profile ID of the agent", "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "rolePermissionType" : { "description" : "Role permission type of the agent", "type" : [ "string" ], "maxLength" : 100, "enum" : [ "AgentPublic", "AgentPersonal", "AgentTeamPersonal", "Admin", "Custom", "Light" ] }, "aboutInfo" : { "description" : "About information of the agent", "type" : [ "string" ], "maxLength" : 255, "pattern" : "[0-9a-zA-Z_\\-\\&\\.\\$\\@\\^\\(\\)\\{\\}\\~\\=\\-\\|\\*\\+\\?\\[\\]\\,\\:\\\"\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "status" : { "description" : "Activation status of the agentPossible values: ACTIVE, DISABLED
", "type" : [ "string" ], "enum" : [ "ACTIVE", "DISABLED" ] }, "channelExpert" : { "description" : "Channels handled by the agent", "type" : [ "array" ], "items" : { "type" : [ "string" ], "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+", "maxLength" : 120 }, "maxLength" : 6000 }, "timeZone" : { "description" : "Time zone of the agent", "type" : [ "string" ], "maxLength" : 100, "pattern" : "[a-zA-Z_/\\-\\+0-9]*", "x-regex-name" : "usertimezone" }, "cf" : { "description" : "User-defined fields related to agents", "maxLength" : 70000, "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } } } }, "examples" : { "Valid requestBody Definitions" : { "value" : { "lastName" : "Marisol Walsh", "firstName" : "K", "phone" : "+1 5550100123", "rolePermissionType" : "Light", "associatedDepartmentIds" : [ "1892000000006907", "1892000000082069" ] } } } } } }, "deleteUnConfAgentRequest" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "agentIds" : { "description" : "ID(s) of the agents", "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, "required" : [ "agentIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "agentIds" : [ 1892000000056007, 1892000000056008 ] } } } } } }, "updateMyEntityPreferenceInputStream" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "data" : { "description" : "User entity preferences", "$ref" : "#/components/schemas/myEntityPreferenceInputArrRequest" } }, "required" : [ "data" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "data" : [ { "entityType" : "department", "entityId" : "1892000000082069", "propName" : "isNotificationEnabled", "propValue" : "ENABLED" }, { "entityType" : "department", "entityId" : "1892000000082070", "propName" : "isNotificationEnabled", "propValue" : "DISABLED" } ] } } } } } } }, "securitySchemes" : { "cookie-auth" : { "$ref" : "./Common.json#/components/securitySchemes/cookie-auth" }, "org-oauth" : { "$ref" : "./Common.json#/components/securitySchemes/org-oauth" }, "iam-oauth2-schema" : { "$ref" : "./Common.json#/components/securitySchemes/iam-oauth2-schema" }, "deprecated-iam-oauth2-schema" : { "$ref" : "./Common.json#/components/securitySchemes/deprecated-iam-oauth2-schema" } } }, "x-entity" : "Agent" }