{ "openapi" : "3.1.0", "info" : { "title" : "Account", "version" : "1.0.0" }, "paths" : { "/api/v1/accounts/{accountId}/associateProducts" : { "post" : { "tags" : [ "Account" ], "summary" : "Associate products with an account", "description" : "This API associates products with an account. Only a maximum of 10 products can be associated with an account through a single API request.", "operationId" : "associateProductsWithAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/associateProductsWithAccount" }, "responses" : { "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/accounts/{accountId}/merge" : { "post" : { "tags" : [ "Account" ], "summary" : "Merge Accounts", "description" : "This API merges two or more accounts.", "operationId" : "mergeAccounts", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/accountMergeRequest" }, "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "#/components/responses/accountResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "500" : { "$ref" : "./Common.json#/components/responses/internalErrorResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/accounts" : { "get" : { "tags" : [ "Account" ], "summary" : "List accounts of contact", "description" : "This API lists the accounts associated with a particular contact.", "operationId" : "getAccountsByContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Number of accounts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Number of accounts to list", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the accounts must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "default" : 1 } }, { "name" : "sortBy", "in" : "query", "description" : "Sort by a specific attribute: @accountName@ or @createdTime@ or @mappingType@ . The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "accountName", "createdTime", "mappingType" ], "pattern" : "-?(accountName|createdTime|mappingType)" } }, { "name" : "startsWith", "in" : "query", "description" : "Letter with which the names of the accounts must start", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "maxLength" : 100 } }, { "name" : "contactId", "in" : "path", "description" : "Unique ID of the contact", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "Key that filters ticket activities related to a particular contact", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/accountListWithMappingInfoArray" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/accounts/{accountId}/statistics" : { "get" : { "tags" : [ "Account" ], "summary" : "Get account statistics", "description" : "This API fetches the overall statistics of an account.", "operationId" : "getAccountStatistics", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "departmentId", "in" : "query", "description" : "Unique ID of the department", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the department from which the statistics must be fetched. If you do not pass this parameter in the API request, statistics from all permitted departments will be fetched.", "pattern" : "([0-9]+)" } }, { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "./Statistics.json#/components/responses/statisticsResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "401" : { "$ref" : "./Common.json#/components/responses/unauthorizedErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/accounts/{accountId}/tickets" : { "get" : { "tags" : [ "Account" ], "summary" : "List tickets by account", "description" : "This API lists tickets received from a specific account.", "operationId" : "getTicketsByAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "include", "in" : "query", "description" : "Additional information related to the tickets. Values allowed are: contacts, products, departments, team, isRead and assignee. You can pass multiple values by separating them with a comma in the API request.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "description" : "Additional information related to the tickets. Values allowed are: @contacts@, @products@, @departments@, @team@, @isRead@ and @assignee@. You can pass multiple values by separating them with a comma in the API request.", "items" : { "type" : [ "string" ], "enum" : [ "contacts", "products", "departments", "team", "assignee", "isRead" ] }, "uniqueItems" : true } }, { "name" : "departmentId", "in" : "query", "description" : "Unique ID of the department", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the department from which the statistics must be fetched. If you do not pass this parameter in the API request, statistics from all permitted departments will be fetched.", "pattern" : "([0-9]+)" } }, { "name" : "dueDate", "in" : "query", "description" : "Filter by ticket duedate. Values allowed are @overdue@, @tomorrow@, @currentWeek@, @currentMonth@ and @today@. You can include both values by separating them with a comma", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "array" ], "maxLength" : 100, "minLength" : 0, "items" : { "type" : "string", "enum" : [ "overdue", "tomorrow", "currentWeek", "currentMonth", "today" ] } } }, { "name" : "limit", "in" : "query", "description" : "Number of accounts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Number of accounts to list", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the accounts must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "default" : 1 } }, { "name" : "sortBy", "in" : "query", "description" : "Sort by a specific attribute: @createdTime@ or @modifiedTime@. The default sorting order is ascending. A @-@ prefix denotes descending order of sorting.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "createdTime", "modifiedTime" ], "pattern" : "-?(createdTime|modifiedTime)" } }, { "name" : "isSpam", "in" : "query", "description" : "Filters Spam tickets", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean" ], "default" : "false" } }, { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account", "required" : true, "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" }, "200" : { "$ref" : "#/components/responses/getTicketsByAccountResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.tickets.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.search.READ" ] } ] } }, "/api/v1/accounts" : { "get" : { "tags" : [ "Account" ], "summary" : "List accounts", "description" : "This API lists a particular number of accounts, based on the limit specified. ", "operationId" : "getAccounts", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "viewId", "in" : "query", "required" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "style" : "form", "explode" : true, "description" : "ID of the view to apply while fetching the resources" }, { "name" : "limit", "in" : "query", "description" : "Number of accounts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Number of accounts to list", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the accounts must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "default" : 1 } }, { "name" : "sortBy", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "website", "email", "phone", "accountName", "createdTime", "modifiedTime" ], "pattern" : "-?(website|email|phone|accountName|createdTime|modifiedTime)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "fields", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ] } }, "description" : "Key that returns the values of mentioned fields (both pre-defined and custom) in your portal. All field types except multi-text are supported. Standard, non-editable fields are supported too. These fields include: @photoURL@, @webUrl@. Maximum of 30 fields is supported as comma separated values.", "style" : "form", "explode" : false }, { "name" : "filters", "in" : "query", "required" : false, "schema" : { "$ref" : "./Ticket.json#/components/schemas/filter_json" }, "description" : "To fetch the accounts based on the filters specified in the criteria JSON, which includes the field and its conditions." }, { "name" : "filterId", "in" : "query", "required" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "description" : "ID of the SavedFilter to filter the records" } ], "responses" : { "200" : { "$ref" : "#/components/responses/accountListArray" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] }, "post" : { "tags" : [ "Account" ], "summary" : "Create Account", "description" : "This API creates an account in your help desk portal.", "operationId" : "createAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/accountjson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "500" : { "$ref" : "./Common.json#/components/responses/internalErrorResponse" }, "200" : { "$ref" : "#/components/responses/accountResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.CREATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.CREATE" ] } ] } }, "/api/v1/accounts/{accountId}/contracts" : { "get" : { "tags" : [ "Account" ], "summary" : "Get Contracts", "description" : "Retrieves contracts for the specified account, with pagination support.", "operationId" : "getContractsByAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "contractStatus", "in" : "query", "description" : "Current status of the contract. Possible values: ACTIVE, EXPIRED, FUTURE.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "ACTIVE", "EXPIRED", "FUTURE" ] } }, { "name" : "departmentId", "in" : "query", "description" : "Unique ID of the department from which the contracts must be fetched.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "format" : "int64", "pattern" : "([0-9]+)" } }, { "name" : "limit", "in" : "query", "description" : "Number of contracts to fetch. Default is 50; range is 1-50.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "default" : 50, "description" : "Number of contracts to fetch. Default is 50; range is 1-50.", "maximum" : 50, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number from which contracts must be fetched.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "default" : 1 } }, { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/getContractsForAccountResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contracts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/accounts/{accountId}" : { "get" : { "tags" : [ "Account" ], "summary" : "Get Account", "description" : "This API fetches an account from your help desk portal.", "operationId" : "getAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "include", "in" : "query", "description" : "Allowed values are : @owner@", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "items" : { "type" : [ "string" ], "enum" : [ "owner" ] }, "uniqueItems" : true, "enum" : [ "owner" ], "pattern" : "(owner)" } }, { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "200" : { "$ref" : "#/components/responses/accountResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] }, "patch" : { "tags" : [ "Account" ], "summary" : "Update Account", "description" : "This API updates details of an existing account.", "operationId" : "updateAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateAccount_accountjson" }, "responses" : { "200" : { "$ref" : "#/components/responses/accountResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/accounts/{accountId}/history" : { "get" : { "tags" : [ "Account" ], "summary" : "Get account history", "description" : "This API fetches the ticket history of an account.", "operationId" : "getTicketHistoryByAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "agentId", "in" : "query", "description" : "Key that filters ticket activities performed by a particular agent", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : " Key that filters ticket activities performed by a particular agent", "pattern" : "([0-9]+)" } }, { "name" : "contactId", "in" : "query", "description" : "Unique ID of the contact", "required" : true, "style" : "form", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "Key that filters ticket activities related to a particular contact", "pattern" : "([0-9]+)" } }, { "name" : "departmentId", "in" : "query", "description" : "Unique ID of the department", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of the department from which the statistics must be fetched. If you do not pass this parameter in the API request, statistics from all permitted departments will be fetched.", "pattern" : "([0-9]+)" } }, { "name" : "limit", "in" : "query", "description" : "Number of accounts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Number of accounts to list", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the accounts must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "default" : 1 } }, { "name" : "accountId", "in" : "path", "description" : "Unique ID of the account", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "./TicketHistory.json#/components/responses/accountContactHistoryResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "401" : { "$ref" : "./Common.json#/components/responses/unauthorizedErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.READ", "Desk.tickets.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/accounts/count" : { "get" : { "tags" : [ "Account" ], "summary" : "List all accounts count", "description" : "Get accounts count", "operationId" : "getAccountsCount", "parameters" : [ { "name" : "viewId", "in" : "query", "description" : "ID of the view to apply while fetching the resources", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "name" : "startsWith", "in" : "query", "description" : "Letter with which the names of the accounts must start", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "maxLength" : 100 } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "#/components/responses/getCountResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/accounts/moveToTrash" : { "post" : { "tags" : [ "Account" ], "summary" : "Delete Accounts", "description" : "This API moves the accounts specified to the Recycle Bin.", "operationId" : "deleteAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/accountsrecyclebinjson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.DELETE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.DELETE" ] } ] } }, "/api/v1/products/{productId}/accounts" : { "get" : { "tags" : [ "Account" ], "summary" : "List accounts associated with product", "description" : "This API lists the accounts associated with a product", "operationId" : "getAccountsByProduct", "x-mcp-group" : [ "Products" ], "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Number of accounts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "description" : "Number of accounts to list", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the accounts must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "default" : 1 } }, { "name" : "sortBy", "in" : "query", "description" : "Key that sorts the accounts by a specific attribute: @accountName@ or @createdTime@.The default sorting order is ascending. A @-@ prefix denotes descending order of sorting", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string" ], "enum" : [ "website", "email", "phone", "accountName", "createdTime", "modifiedTime" ], "pattern" : "-?(website|email|phone|accountName|createdTime|modifiedTime)" } }, { "name" : "productId", "in" : "path", "required" : true, "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" }, "200" : { "$ref" : "#/components/responses/accountListArray" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.READ", "Desk.settings.READ" ] } ] } }, "/api/v1/accounts/updateMany" : { "post" : { "tags" : [ "Account" ], "summary" : "Update many accounts", "description" : "This API updates multiple accounts at once.", "operationId" : "bulkUpdateAccounts", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/account_massupdate" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/updateManyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.accounts.UPDATE" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } } }, "components" : { "schemas" : { "zohoCrmAccount" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "id" ] }, "commonObject" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "website" : { "type" : [ "string", "null" ], "description" : "Website of the account", "maxLength" : 120, "pattern" : "^(ht|f)tp(s?)\\:\\/\\/[-.\\w]*(\\/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'\\/\\\\+=&%\\$#_@]*)?$" }, "accountName" : { "type" : [ "string", "null" ], "description" : "Name of the account", "maxLength" : 200 }, "phone" : { "type" : [ "string", "null" ], "description" : "Phone number of the account", "maxLength" : 30, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\;\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "email" : { "type" : [ "string", "null" ], "description" : "Email ID of the account", "maxLength" : 255, "pattern" : "^[\\p{L}\\p{M}\\p{N}\\_]([\\p{L}\\p{M}\\p{N}\\_\\+\\-\\.\\'&\\!\\~]*)@(?=.{4,256}$)(([\\p{L}\\p{N}\\p{M}]+)(([\\-\\_]*[\\p{L}\\p{N}\\p{M}])*)[\\.])+[\\p{L}\\p{M}]{2,22}$" } } }, "accountjson" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonObject" }, { "type" : [ "object", "null" ], "properties" : { "country" : { "type" : [ "string", "null" ], "maxLength" : 30, "minLength" : 0 }, "code" : { "type" : [ "string", "null" ], "maxLength" : 30, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "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])+" } } }, "city" : { "type" : [ "string", "null" ], "maxLength" : 30, "minLength" : 0 }, "customFields" : { "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])+" } } }, "street" : { "type" : [ "string", "null" ], "maxLength" : 250, "minLength" : 0 }, "annualrevenue" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)" }, "description" : { "type" : [ "string", "null" ], "maxLength" : 65535, "minLength" : 0 }, "industry" : { "type" : [ "string", "null" ], "maxLength" : 120, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "state" : { "type" : [ "string", "null" ], "maxLength" : 30, "minLength" : 0 }, "ownerId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "fax" : { "type" : [ "string", "null" ], "maxLength" : 30, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" } }, "required" : [ "annualrevenue", "cf", "city", "code", "country", "customFields", "description", "fax", "industry", "ownerId", "state", "street" ], "additionalProperties" : false }, { "type" : [ "object" ], "required" : [ "accountName" ] } ] }, "sourceValues" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "country" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "website" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "code" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "cf" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } }, "city" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "customFields" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } }, "description" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "industry" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "phone" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "annualrevenue" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "street" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "state" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "fax" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "email" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "annualrevenue", "cf", "city", "code", "country", "customFields", "description", "email", "fax", "industry", "phone", "state", "street", "website" ] }, "mappingInfo" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "mappingId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "mappingType" : { "type" : [ "string", "null" ], "enum" : [ "PRIMARY", "SECONDARY" ] }, "isAccountTicketsViewable" : { "type" : [ "boolean", "null" ] } }, "required" : [ "isAccountTicketsViewable", "mappingId", "mappingType" ] }, "accountListViewObject" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonObject" }, { "type" : [ "object", "null" ], "properties" : { "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "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))" }, "zohoCRMAccount" : { "$ref" : "#/components/schemas/zohoCrmAccount" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "customerHappiness" : { "$ref" : "./Contact.json#/components/schemas/customerHappiness" } }, "required" : [ "createdTime", "customerHappiness", "id", "webUrl", "zohoCRMAccount" ], "additionalProperties" : false }, { "type" : [ "object" ], "required" : [ "accountName", "email", "phone" ] } ] }, "accountListWithMappingInfo" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/accountListViewObject" }, { "type" : [ "object", "null" ], "properties" : { "mappingInfo" : { "$ref" : "#/components/schemas/mappingInfo" }, "mappingType" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 } }, "required" : [ "mappingInfo", "mappingType" ], "additionalProperties" : false } ] }, "dataWitMappingInfo" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/accountListWithMappingInfo" } }, "getTicketsByAccountListObject" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "./Ticket.json#/components/schemas/listviewCommonJson" }, { "type" : [ "object", "null" ], "properties" : { "subCategory" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true }, "category" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true }, "layoutId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "category", "layoutId", "subCategory" ], "additionalProperties" : false } ] }, "getTicketsByAccountArr" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/getTicketsByAccountListObject" } }, "contractsForAccountDataListJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "slaName" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "description" : "Name of the SLA associated with the contract." }, "slaGroupId" : { "type" : [ "string", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the SLA group." }, "endDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$", "description" : "End date of the contract." }, "departmentId" : { "type" : [ "string", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the department associated with the contract." }, "contractId" : { "type" : [ "string", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contract." }, "contractNumber" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Contract number." }, "description" : { "type" : [ "string", "null" ], "maxLength" : 65535, "minLength" : 0, "description" : "Description of the contract." }, "contractName" : { "type" : [ "string", "null" ], "maxLength" : 80, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+", "description" : "Name of the contract." }, "ownerId" : { "type" : [ "string", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Unique ID of the contract owner." }, "startDate" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0, "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$", "description" : "Start date of the contract." } }, "required" : [ "contractId", "contractName", "contractNumber", "departmentId", "endDate", "slaGroupId", "slaName", "startDate" ] }, "contractsForAccountData" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/contractsForAccountDataListJson" } }, "data" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/accountListViewObject" } }, "long_array" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } }, "responses" : { "accountResponse" : { "description" : "accountResponse template definitions", "content" : { "application/json" : { "schema" : { "allOf" : [ { "type" : [ "object" ], "properties" : { "owner" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "firstName", "id", "lastName" ] } }, "additionalProperties" : false }, { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/accountjson" }, { "type" : [ "object", "null" ], "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))" }, "isFollowing" : { "type" : [ "boolean", "null" ] }, "isDeleted" : { "type" : [ "boolean", "null" ] }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "associatedSLAIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "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))" }, "zohoCRMAccount" : { "$ref" : "#/components/schemas/zohoCrmAccount" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "layoutId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "layoutDetails" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "layoutName" : { "type" : [ "string", "null" ], "maxLength" : 120, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "required" : [ "id", "layoutName" ] } }, "required" : [ "associatedSLAIds", "createdTime", "id", "isDeleted", "isFollowing", "isTrashed", "layoutDetails", "layoutId", "modifiedTime", "webUrl", "zohoCRMAccount" ], "additionalProperties" : false } ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "country" : "USA", "modifiedTime" : 1425307758000, "code" : "3211", "accountName" : "Zylker", "city" : null, "associatedSLAIds" : [ 3263000000057, 3000000057001 ], "description" : null, "industry" : "Automation", "zohoCRMAccount" : { "id" : "32754000000537001" }, "ownerId" : "3263000000057001", "isDeleted" : false, "isTrashed" : false, "street" : null, "annualrevenue" : null, "createdTime" : 1424105864000, "state" : null, "id" : "3263000000074571", "fax" : "+1 5550100123", "email" : "support@zylker.com", "owner" : { "firstName" : "Twin", "lastName" : "john", "id" : "3263000000057001" }, "website" : "www.zylker.com", "cf" : { "cf_contactcount" : "1" }, "isFollowing" : "true", "phone" : "+1 5550100123", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38" } } } } } }, "accountListWithMappingInfoArray" : { "description" : "accountListWithMappingInfoArray template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/dataWitMappingInfo" } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "website" : "www.zoho.com", "accountName" : "ZOHO", "phone" : "+1 5550100123", "mappingInfo" : { "mappingId" : 1892000000052072, "mappingType" : "PRIMARY", "isAccountTicketsViewable" : true }, "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1424105864000, "zohoCRMAccount" : { "id" : "32754000000537001" }, "customerHappiness" : { "badPercentage" : "30", "okPercentage" : "30", "goodPercentage" : "40" }, "id" : "1892000000052077", "email" : "admin@zylker.com" } ] } } } } } }, "getTicketsByAccountResponse" : { "description" : "getTicketsByAccountResponse template definitions", "content" : { "application/json" : { "schema" : { "allOf" : [ { "type" : [ "object" ], "properties" : { "data" : { "type" : [ "array" ], "items" : { "type" : [ "object" ], "properties" : { "product" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "productName" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0 } }, "required" : [ "id", "productName" ] }, "contact" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 8, "minProperties" : 8, "properties" : { "lastName" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0 }, "firstName" : { "type" : [ "string", "null" ], "maxLength" : 40, "minLength" : 0 }, "phone" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "type" : { "type" : [ "string", "null" ], "x-dynamic-enum" : true }, "email" : { "type" : [ "string", "null" ], "maxLength" : 255, "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}$" }, "account" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "website" : { "type" : [ "string", "null" ], "maxLength" : 120, "minLength" : 0 }, "accountName" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0 }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "accountName", "id", "website" ] } }, "required" : [ "account", "email", "firstName", "id", "lastName", "mobile", "phone", "type" ] }, "isRead" : { "type" : [ "boolean", "null" ] }, "team" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "name" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 1, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "logoUrl" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" } }, "required" : [ "id", "logoUrl", "name" ] }, "assignee" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 5, "minProperties" : 5, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50, "minLength" : 0 }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "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}$" } }, "required" : [ "email", "firstName", "id", "lastName", "photoURL" ] }, "department" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "name" : { "type" : [ "string", "null" ], "maxLength" : 200, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "id", "name" ] } }, "additionalProperties" : false } } }, "additionalProperties" : false }, { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/getTicketsByAccountArr" } }, "required" : [ "data" ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "ticketNumber" : "149", "statusType" : "Open", "subject" : "Hi. There is a sudden delay in the processing of the orders. Check this with high priority", "dueDate" : 1509778989000, "departmentId" : "1892000000006907", "channel" : "Email", "isRead" : false, "onholdTime" : null, "language" : "English", "closedTime" : null, "contact" : { "lastName" : "Carol", "firstName" : "Lucas", "phone" : "+1 5550100123", "mobile" : "+1 5550100123", "id" : "18944000000421011", "type" : null, "email" : "carol@zylker.com", "account" : { "website" : "www.desk.com", "accountName" : "desk Account", "id" : "1892000000975382" } }, "createdTime" : 1507813910000, "id" : "18944000000336005", "department" : { "name" : "dasdasdasd", "id" : "1892000000006907" }, "email" : "support@zylker.com", "customerResponseTime" : 1509692589203, "productId" : "18944000000424033", "contactId" : "18944000000421011", "threadCount" : "7", "lastThread" : null, "team" : { "name" : "kjsdfjks", "id" : "8920000000069071", "logoUrl" : "https://desk.zoho.com/api/v1/teams/8920000000069071/logo?orgId=123456" }, "priority" : "Medium", "assigneeId" : "1892000000042001", "commentCount" : "0", "accountId" : "189200000005345", "phone" : "+1 5550100123", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Cases/dv/20d7881a46edfcffefe308ab38676ec3e612657a51fd5fbe", "teamId" : "8920000000069071", "isSpam" : false, "assignee" : { "firstName" : "dasca", "lastName" : "vins", "photoURL" : "https://desk.zoho.com/api/v1/agent/1892000000042001/photo", "id" : "1892000000042001", "email" : "jack@zylker.com" }, "status" : "Open" } ] } } } } } }, "getContractsForAccountResponse" : { "description" : "List of contracts associated with the account.", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/contractsForAccountData", "description" : "List of contracts associated with the account." } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "slaName" : "Priority-based SLAs", "endDate" : 1468627200000, "slaGroupId" : "4000000007069", "departmentId" : "4000000007043", "contractId" : "4000000032003", "contractNumber" : "1212", "description" : "contract for all desk account", "contractName" : "Contract for desk account", "ownerId" : "4000000008692", "startDate" : 1466035200000 } ] } } } } } }, "getCountResponse" : { "description" : "getCountResponse template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "count" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "Number of accounts returned for the requested filters" } }, "required" : [ "count" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "count" : "10" } } } } } }, "accountListArray" : { "description" : "accountListArray template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/data" } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "website" : "112121", "accountName" : "Admin Account", "phone" : "121212", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1424105864000, "zohoCRMAccount" : { "id" : "32754000000537001" }, "customerHappiness" : { "badPercentage" : "30", "okPercentage" : "30", "goodPercentage" : "40" }, "id" : "1892000000052077", "email" : "admin@zylker.com" }, { "website" : "1211212", "accountName" : "Agent Account", "phone" : "11211", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Accounts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1424105864000, "zohoCRMAccount" : { "id" : "32754000000537001" }, "customerHappiness" : { "badPercentage" : "20", "okPercentage" : "40", "goodPercentage" : "40" }, "id" : "1892000000052090", "email" : "agent@zylker.com" } ] } } } } } }, "updateManyResponse" : { "description" : "updateManyResponse template definitions", "content" : { "application/json" : { "schema" : { "oneOf" : [ { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "result" : { "$ref" : "./MassActionResponse.json#/components/schemas/results" } }, "required" : [ "result" ] }, { "additionalProperties" : false, "allOf" : [ { "$ref" : "./Common.json#/components/schemas/errorJson" }, { "type" : [ "object", "null" ], "properties" : { "errors" : { "type" : [ "array", "null" ], "items" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "fieldName" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 }, "errorType" : { "type" : [ "string", "null" ], "enum" : [ "invalid", "duplicate", "missing" ] }, "errorMessage" : { "type" : [ "string", "null" ], "maxLength" : 100, "minLength" : 0 } }, "required" : [ "errorMessage", "errorType", "fieldName" ] }, "uniqueItems" : false } }, "required" : [ "errors" ], "additionalProperties" : false } ] }, { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "errorCode" : { "type" : [ "string", "null" ], "enum" : [ "URL_NOT_FOUND", "UNAUTHORIZED", "INVALID_OAUTH", "SCOPE_MISMATCH", "FORBIDDEN", "LICENSE_ACCESS_LIMITED", "METHOD_NOT_ALLOWED", "RESOURCE_SIZE_EXCEEDED", "UNSUPPORTED_MEDIA_TYPE", "INVALID_DATA", "UNPROCESSABLE_ENTITY", "ONLY_LIVECHAT_USER", "INTEGRATION_ADMIN_ERROR", "THRESHOLD_EXCEEDED", "INTERNAL_SERVER_ERROR", "EMPTY_PAYLOAD" ] }, "message" : { "type" : [ "string", "null" ], "maxLength" : 255, "minLength" : 0 } }, "required" : [ "errorCode", "message" ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "result" : [ { "success" : true, "id" : "1892000000093303", "errors" : null }, { "success" : true, "id" : "1892000000085009", "errors" : null }, { "success" : false, "id" : "1892000000050003", "errors" : { "errorCode" : "UNPROCESSABLE_ENTITY", "httpCode" : "422" } } ] } } } } } } }, "requestBodies" : { "associateProductsWithAccount" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "departmentId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "ids" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "associate" : { "type" : [ "boolean" ] } }, "required" : [ "associate", "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "departmentId" : "7000000062800", "ids" : [ "7000000027223", "7000000043968" ], "associate" : true } } } } } }, "accountMergeRequest" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "ids" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : true }, "source" : { "$ref" : "#/components/schemas/sourceValues" } }, "required" : [ "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "ids" : [ "4000000018011", "4000000018033" ], "source" : { "country" : "4000000018011", "website" : "4000000018011", "code" : "4000000018011", "cf" : { "cf_contactcount" : 1892220000042001 }, "city" : "4000000018011", "description" : "4000000018011", "industry" : "4000000018011", "phone" : "+1 5550100123", "annualrevenue" : "4000000018011", "street" : "4000000018011", "state" : "4000000018011", "fax" : "+1 5550100123", "email" : "4000000018011" } } } } } } }, "accountjson" : { "content" : { "application/json" : { "schema" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonObject" }, { "type" : [ "object" ], "properties" : { "country" : { "type" : [ "string" ], "description" : "Country in which the account is based", "maxLength" : 100 }, "code" : { "type" : [ "string" ], "description" : "Zip code", "maxLength" : 30, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "cf" : { "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])+" } } }, "city" : { "type" : [ "string" ], "description" : "City in which the account is based", "maxLength" : 100 }, "customFields" : { "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])+" } } }, "street" : { "type" : [ "string" ], "description" : "Address of the account", "maxLength" : 250 }, "annualrevenue" : { "type" : [ "string" ], "description" : "Annual revenue of the account", "maxLength" : 100, "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)" }, "description" : { "type" : [ "string" ], "description" : "A short description of the account", "maxLength" : 65535 }, "industry" : { "type" : [ "string" ], "description" : "Industry in which the account operates", "maxLength" : 120, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "state" : { "type" : [ "string" ], "description" : "State in which the account is based", "maxLength" : 100 }, "ownerId" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of account owner", "pattern" : "([0-9]*|null|undefined)" }, "fax" : { "type" : [ "string" ], "description" : "Fax number of the account", "maxLength" : 30, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\$@\\?\\,\\;\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" } }, "additionalProperties" : false }, { "type" : [ "object" ], "properties" : { "associatedSLAIds" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "layoutId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } } } ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "accountName" : "Zylker", "phone" : "+1 5550100123" } } } } } }, "updateAccount_accountjson" : { "content" : { "application/json" : { "schema" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonObject" }, { "type" : [ "object" ], "properties" : { "country" : { "type" : [ "string" ], "description" : "Country in which the account is based", "maxLength" : 30, "minLength" : 0 }, "code" : { "type" : [ "string" ], "description" : "Zip code", "maxLength" : 30, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "cf" : { "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])+" } } }, "city" : { "type" : [ "string" ], "description" : "City in which the account is based", "maxLength" : 30, "minLength" : 0 }, "customFields" : { "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])+" } } }, "street" : { "type" : [ "string" ], "description" : "Address of the account", "maxLength" : 250, "minLength" : 0 }, "annualrevenue" : { "type" : [ "string" ], "description" : "Annual revenue of the account", "maxLength" : 100, "minLength" : 0, "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)" }, "description" : { "type" : [ "string" ], "description" : "A short description of the account", "maxLength" : 65535, "minLength" : 0 }, "industry" : { "type" : [ "string" ], "description" : "Industry in which the account operates", "maxLength" : 120, "minLength" : 0, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" }, "state" : { "type" : [ "string" ], "description" : "State in which the account is based", "maxLength" : 30, "minLength" : 0 }, "ownerId" : { "type" : [ "string", "integer" ], "format" : "int64", "description" : "ID of account owner", "pattern" : "([0-9]+)" }, "fax" : { "type" : [ "string" ], "description" : "Fax number of the account", "maxLength" : 30, "minLength" : 0, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" } }, "additionalProperties" : false }, { "type" : [ "object" ], "properties" : { "associatedSLAIds" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "layoutId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } } } ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "accountName" : "Zylker", "phone" : "+1 5550100123" } } } } } }, "account_massupdate" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "isCustomField" : { "type" : [ "boolean" ] }, "fieldName" : { "type" : [ "string" ], "x-dynamic-enum" : true }, "ids" : { "$ref" : "#/components/schemas/long_array" }, "fieldValue" : { "type" : [ "string" ], "maxLength" : 320 } }, "required" : [ "fieldName", "ids", "fieldValue" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "fieldName" : "phone", "isCustomField" : false, "ids" : [ "1892000000093303", "1892000000085009", "1892000000050003" ], "fieldValue" : "8508569875" } } } } } }, "accountsrecyclebinjson" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "accountIds" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, "required" : [ "accountIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "accountIds" : [ "2000032003232" ] } } } } } } }, "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" : "Account" }