{ "openapi" : "3.1.0", "info" : { "title" : "Contact", "version" : "1.0.0" }, "paths" : { "/api/v1/products/{productId}/contacts" : { "get" : { "tags" : [ "Contact" ], "summary" : "List contacts associated with product", "description" : "This API lists the contacts associated with a product.", "operationId" : "getContactsUnderProduct", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "limit", "in" : "query", "description" : "Number of contacts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)", "description" : "Number of contacts to fetch" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the contacts must be listed", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Index number, starting from which the contacts must be listed" } }, { "name" : "isSpam", "in" : "query", "description" : "Filters Spam contacts", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean", "null" ], "default" : "false", "description" : "Filters Spam contacts" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "include", "in" : "query", "description" : "Key that fetches secondary information related to the contact.Value allowed is @accounts@", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "description" : "Key that fetches secondary information related to the contact.Value allowed is @accounts@", "pattern" : "(accounts)" } }, { "name" : "sortBy", "in" : "query", "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@phone,@! !@email,@! !@account,@! !@createdTime,@! !@modifiedTime@!", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@phone,@! !@email,@! !@account,@! !@createdTime,@! !@modifiedTime@!", "enum" : [ "firstName", "lastName", "phone", "email", "account", "createdTime", "modifiedTime" ], "maxLength" : 100, "pattern" : "-?(firstName|lastName|phone|email|account|createdTime|modifiedTime)" } }, { "name" : "productId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/contactListViewArray" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] }, { "deprecated-iam-oauth2-schema" : [ "Desk.settings.READ" ] } ] } }, "/api/v1/contacts/inviteAsEndUser" : { "post" : { "tags" : [ "Contact" ], "summary" : "Invite multiple contacts to help center", "description" : "This API helps invite multiple contacts as end-users to your help center.", "operationId" : "inviteContactsAsEndUser", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/inviteContactsAsEndUser" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListSuccessNullResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/photo" : { "delete" : { "tags" : [ "Contact" ], "summary" : "Delete contact photo", "description" : "This API deletes the display picture of a contact.", "operationId" : "deleteContactPhoto", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "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.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/statistics" : { "get" : { "tags" : [ "Contact" ], "summary" : "Get contact statistics", "description" : "This API fetches the overall statistics of an contact.", "operationId" : "getContactStatistics", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "departmentId", "in" : "query", "required" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "style" : "form", "explode" : true, "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." }, { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "department", "in" : "query", "description" : "_This Param is being deprecated please use the departmentId param to fetch the department specific statistics_", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "description" : "_This Param is being deprecated please use the departmentId param to fetch the department specific statistics_", "pattern" : "allDepartment|[0-9]+", "x-regex-name" : "departmentsInAPI" } }, { "name" : "timeRange", "in" : "query", "description" : "Key that filters statistics observed in a specific date and time range. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, timeRange=2017-11-05T00:00:00.000Z,2018-02-05T23:59:00.000Z. The maximum period allowed for the time range is six months.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "description" : "Key that filters statistics observed in a specific date and time range. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, timeRange=2017-11-05T00:00:00.000Z,2018-02-05T23:59:00.000Z. The maximum period allowed for the time range is six months.", "maxLength" : 100, "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)),(((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))|null" } } ], "responses" : { "200" : { "$ref" : "#/components/responses/getStatistics" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/contacts/{contactId}/dissociateAccounts" : { "post" : { "tags" : [ "Contact" ], "summary" : "Dissociate accounts from contact", "description" : "This API dissociates multiple accounts from a particular contact.", "operationId" : "dissociateAccountsWithContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/dissociateAccountsWithContact" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/moveToTrash" : { "post" : { "tags" : [ "Contact" ], "summary" : "Delete Contacts", "description" : "This API moves the contacts specified to the Recycle Bin.", "operationId" : "deleteContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/deleteContactsRequest" }, "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "500" : { "$ref" : "./Common.json#/components/responses/internalErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.DELETE" ] } ] } }, "/api/v1/contacts/{contactId}/accounts/{accountId}/dissociate" : { "patch" : { "tags" : [ "Contact" ], "summary" : "Dissociate account from contact", "description" : "This API dissociates a particular account from a contact.", "operationId" : "dissociateAccountWithContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "accountId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "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.contacts.UPDATE" ] } ], "requestBody" : { "$ref" : "#/components/requestBodies/removeContactAccountMapping" } } }, "/api/v1/contacts/{contactId}/helpCenters" : { "get" : { "tags" : [ "Contact" ], "summary" : "Get status of contact in help centers", "description" : "This API fetches a particular contact's activation status in all the help centers they are part of.", "operationId" : "getContactActivationStatusAcrossHelpCenters", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "helpCenterId", "in" : "query", "required" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "style" : "form", "explode" : true, "description" : "To get specific helpcenter info" }, { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./ResponseHelpCenterUser.json#/components/responses/listHelpCenters" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/contacts/{contactId}/history" : { "get" : { "tags" : [ "Contact" ], "summary" : "Get contact history", "description" : "This API fetches the ticket history of a contact.", "operationId" : "getContactTicketHistory", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "limit", "in" : "query", "description" : " Number of history details to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)", "description" : " Number of history details to fetch" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the contacts must be listed", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Index number, starting from which the contacts must be listed" } }, { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "agentId", "in" : "query", "description" : " Key that filters ticket activities performed by a particular agent", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "description" : " Key that filters ticket activities performed by a particular agent", "pattern" : "([0-9]+)" } }, { "name" : "departmentId", "in" : "query", "description" : " ID of the department from which the history details must be fetched", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "description" : " ID of the department from which the history details must be fetched", "pattern" : "([0-9]+)" } } ], "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.contacts.READ", "Desk.tickets.READ" ] } ] } }, "/api/v1/contacts" : { "get" : { "tags" : [ "Contact" ], "summary" : "List Contacts", "description" : "This API lists a particular number of contacts, based on the limit specified. ", "operationId" : "getContacts", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "fields", "in" : "query", "required" : false, "schema" : { "type" : [ "array" ], "items" : { "type" : [ "string" ], "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+|\\$\\{VIEW_FIELDS\\})" }, "maxItems" : 30 }, "style" : "form", "explode" : true, "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." }, { "name" : "viewId", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, { "name" : "limit", "in" : "query", "description" : "Number of contacts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "maximum" : 100, "minimum" : 1, "pattern" : "(^([a-zA-Z0-9\\s\\.\\?\\,])*$|null|undefined)", "description" : "Number of contacts to fetch", "x-regex-name" : "String_null" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the contacts must be listed", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Index number, starting from which the contacts must be listed" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "filterId", "in" : "query", "required" : false, "schema" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "description" : "ID of the SavedFilter to filter the records" }, { "name" : "include", "in" : "query", "required" : false, "style" : "simple", "explode" : true, "schema" : { "type" : [ "null", "array" ], "items" : { "type" : [ "string", "null" ], "enum" : [ "accounts" ], "maxLength" : 100 }, "uniqueItems" : true } }, { "name" : "sortBy", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "enum" : [ "firstName", "lastName", "phone", "email", "account", "createdTime", "modifiedTime" ], "maxLength" : 100, "pattern" : "-?(firstName|lastName|phone|email|account|createdTime|modifiedTime)" } } ], "responses" : { "200" : { "$ref" : "#/components/responses/contactListViewArray" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] }, "post" : { "tags" : [ "Contact" ], "summary" : "Create Contact", "description" : "This API creates a contact in your help desk portal.", "operationId" : "createContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/contactjson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/contactResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.CREATE" ] } ] } }, "/api/v1/contacts/updateMany" : { "post" : { "tags" : [ "Contact" ], "summary" : "Update many contacts", "description" : "This API updates multiple contacts at once.", "operationId" : "bulkUpdateContacts", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/contact_massupdate" }, "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "401" : { "$ref" : "./Common.json#/components/responses/unauthorizedErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/count" : { "get" : { "tags" : [ "Contact" ], "summary" : "Get contacts count", "description" : "This API displays the count for the number of contacts in a custom view", "operationId" : "getContactsCount", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "filter", "in" : "query", "required" : false, "schema" : { "$ref" : "./Ticket.json#/components/schemas/filter_json" }, "description" : "To fetch the contacts count 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" }, { "name" : "viewId", "in" : "query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "name" : "startsWith", "in" : "query", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "maxLength" : 100 } } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/countJson" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/contacts/contactsByIds" : { "get" : { "tags" : [ "Contact" ], "summary" : "List Contacts By Ids", "description" : "This API lists details of specific contacts, based on the IDs passed in the request.", "operationId" : "getContactsByIds", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "ids", "in" : "query", "description" : "List of Contact Ids (separated by comma) which must be fetched. The maximum number of IDs allowed is 20.", "required" : true, "style" : "simple", "explode" : true, "schema" : { "type" : [ "null", "array" ], "description" : "List of Contact Ids (separated by comma) which must be fetched. The maximum number of IDs allowed is 20.", "items" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } } ], "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/multipleUnprocessEntityResponse" }, "200" : { "$ref" : "#/components/responses/contactListViewArray" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/contacts/{contactId}" : { "get" : { "tags" : [ "Contact" ], "summary" : "Get Contact", "description" : "This API fetches a single contact from your help desk portal.", "operationId" : "getContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "include", "in" : "query", "description" : "Allowed values are : @accounts@ , @owner@", "required" : false, "style" : "simple", "explode" : true, "schema" : { "type" : [ "null", "array" ], "description" : "Allowed values are : @accounts@ , @owner@", "items" : { "type" : [ "string", "null" ], "enum" : [ "accounts", "owner" ], "maxLength" : 100 }, "uniqueItems" : true } } ], "responses" : { "200" : { "$ref" : "#/components/responses/contactResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] }, "patch" : { "tags" : [ "Contact" ], "operationId" : "updateContact", "x-mcp-group" : [ "Contacts" ], "summary" : "Update Contact", "description" : "This API updates details of an existing contact.", "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateContact_contactjson" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "#/components/responses/contactResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/merge" : { "post" : { "tags" : [ "Contact" ], "summary" : "Merge Contacts", "description" : "This API merges two or more contacts

_Note:_
Though portal users (users who signed up via the help center) are saved as contacts in the help desk, their records cannot be merged with other records/contacts.", "operationId" : "mergeContacts", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/contactMergeRequest" }, "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "#/components/responses/contactResponse" }, "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.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/approveEndUserInvite" : { "post" : { "tags" : [ "Contact" ], "summary" : "Approve contact for help center", "description" : "This API helps approve a particular contact as an end-user to your help center.", "operationId" : "approveEndUserInvite", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateSignupApproval" }, "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" }, "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.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/rejectEndUserInvite" : { "post" : { "tags" : [ "Contact" ], "summary" : "Reject contact for help center", "description" : "This API helps reject a particular contact from being added as an end-user to your help center.", "operationId" : "rejectEndUserInvite", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/rejectEndUserInvite_updateSignupApproval" }, "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" }, "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.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/associateAccounts" : { "post" : { "tags" : [ "Contact" ], "summary" : "Associate accounts with contact", "description" : "This API associates multiple accounts with a particular contact.", "operationId" : "associateAccountsWithContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/associateAccountsWithContact" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListSuccessNullResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/{contactId}/associateProducts" : { "post" : { "tags" : [ "Contact" ], "summary" : "Associate products with a contact", "description" : "This API associates products with a contact. Only a maximum of 10 products can be associated with a contact through a single API request.", "operationId" : "associateProductsWithContact", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/associateProductsWithContact" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/markSpam" : { "post" : { "tags" : [ "Contact" ], "summary" : "Mark contact as spam", "description" : "This API marks contacts as spam.", "operationId" : "markContactsAsSpam", "x-mcp-group" : [ "Contacts" ], "requestBody" : { "$ref" : "#/components/requestBodies/markSpamContactPayload" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListSuccessNullResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/contacts/deleteSpam" : { "post" : { "tags" : [ "Contact" ], "summary" : "Delete spam contacts", "description" : "This API deletes the given spam contacts", "operationId" : "deleteSpamContacts", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/deleteSpamContacts_deleteContactsRequest" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.DELETE" ] } ] } }, "/api/v1/contacts/{contactId}/inviteAsEndUser" : { "post" : { "tags" : [ "Contact" ], "summary" : "Invite contact to help center", "description" : "This API helps invite a particular contact as an end-user to your help center.", "operationId" : "inviteContactAsEndUser", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/inviteContactAsEndUser" }, "responses" : { "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" }, "200" : { "$ref" : "./MassActionResponse.json#/components/responses/massActionListSuccessNullResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/accounts/{accountId}/contacts" : { "get" : { "tags" : [ "Contact" ], "summary" : "List Associated contacts", "description" : "This API lists the contacts associated with an account", "operationId" : "getContactsUnderAccount", "x-mcp-group" : [ "Accounts" ], "parameters" : [ { "name" : "limit", "in" : "query", "description" : "No. of contacts to fetch", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer" ], "format" : "int32", "maximum" : 100, "minimum" : 1, "pattern" : "([0-9]+)", "description" : "No. of contacts to fetch" } }, { "name" : "from", "in" : "query", "description" : "Index number, starting from which the contacts must be listed", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "integer", "string", "null" ], "format" : "int32", "pattern" : "([0-9]+)", "description" : "Index number, starting from which the contacts must be listed" } }, { "name" : "isSpam", "in" : "query", "description" : "Filters Spam contacts", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "boolean", "null" ], "default" : "false", "description" : "Filters Spam contacts" } }, { "name" : "accountId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "sortBy", "in" : "query", "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@fullName,@! !@phone,@! !@email,@! !@createdTime,@! !@modifiedTime@!", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : [ "string", "null" ], "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@fullName,@! !@phone,@! !@email,@! !@createdTime,@! !@modifiedTime@!", "enum" : [ "firstName", "lastName", "phone", "fullName", "email", "createdTime", "modifiedTime" ], "maxLength" : 100, "pattern" : "-?(firstName|lastName|fullName|phone|email|createdTime|modifiedTime)", "x-regex-name" : "contactSortFields" } } ], "responses" : { "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "200" : { "$ref" : "#/components/responses/contactListViewArrayWithMappingInfo" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/contacts/{contactId}/accountsCount" : { "get" : { "tags" : [ "Contacts" ], "summary" : "Get associated accounts count for a contact", "description" : "Returns the count of accounts associated with a specific contact.", "operationId" : "getAssociatedAccountsCountForContact", "parameters" : [ { "$ref" : "./Common.json#/components/parameters/orgId" }, { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } ], "responses" : { "200" : { "$ref" : "#/components/responses/countJson" }, "204" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "400" : { "$ref" : "./Common.json#/components/responses/badRequestErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.READ" ] } ] } }, "/api/v1/contacts/{contactId}/updateTicketsAccount" : { "post" : { "tags" : [ "Contact" ], "summary" : "Update tickets account for contact", "description" : "Updates the account associated with the tickets of the specified contact.", "operationId" : "updateTicketsAccount", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "contactId", "in" : "path", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, { "$ref" : "./Common.json#/components/parameters/orgId" } ], "requestBody" : { "$ref" : "#/components/requestBodies/updateTicketsAccount" }, "responses" : { "404" : { "$ref" : "./Common.json#/components/responses/urlNotFoundErrorResponse" }, "200" : { "$ref" : "./Common.json#/components/responses/emptyResponse" }, "422" : { "$ref" : "./Common.json#/components/responses/invalidDataErrorResponse" }, "500" : { "$ref" : "./Common.json#/components/responses/internalErrorResponse" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ] } ] } }, "/api/v1/portalUser/{userId}/photo" : { "get" : { "tags" : [ "Contact" ], "summary" : "Get portal user photo", "description" : "Retrieves the profile photo of the specified portal user.", "operationId" : "getUserPhotoStream", "x-mcp-group" : [ "Contacts" ], "parameters" : [ { "name" : "userId", "in" : "path", "required" : true, "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" }, "403" : { "$ref" : "./Common.json#/components/responses/forbiddenErrorResponse" }, "500" : { "$ref" : "./Common.json#/components/responses/internalErrorResponse" } }, "security" : [ { "iam-oauth2-schema" : [ "Desk.tickets.READ" ] } ] } } }, "components" : { "schemas" : { "customerHappiness" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "badPercentage" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "okPercentage" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "goodPercentage" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" } }, "required" : [ "badPercentage", "goodPercentage", "okPercentage" ] }, "zohoCRMContact" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "type" : { "type" : [ "string", "null" ], "enum" : [ "new", "potentials", "customers", "contacts", "leads" ], "maxLength" : 100 } }, "required" : [ "id", "type" ] }, "commonJson" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "lastName" : { "type" : [ "string", "null" ], "description" : "Last name of the contact", "maxLength" : 200 }, "accountId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "Account to which the contact is mapped", "pattern" : "([0-9]*|null|undefined)" }, "firstName" : { "type" : [ "string", "null" ], "description" : "First name of the contact", "maxLength" : 40 }, "secondaryEmail" : { "type" : [ "string", "null" ], "description" : "Secondary email ID of the contact", "maxLength" : 100, "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}$", "x-regex-name" : "emailDesk" }, "phone" : { "type" : [ "string", "null" ], "description" : "Phone number of the contact", "maxLength" : 50, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]", "x-regex-name" : "inv_clrtxtpatrn_phone" }, "mobile" : { "type" : [ "string", "null" ], "description" : "Mobile number of the contact", "maxLength" : 50, "pattern" : "[^0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]", "x-regex-name" : "inv_clrtxtpatrn_phone" }, "ownerId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "description" : "ID of the user who creates the contact", "pattern" : "([0-9]*|null|undefined)" }, "type" : { "type" : [ "string", "null" ], "description" : "Contact type", "x-dynamic-enum" : true, "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+" }, "email" : { "type" : [ "string", "null" ], "description" : "Email ID of the contact", "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}$", "x-regex-name" : "emailDesk" } } }, "listViewObject" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJson" }, { "type" : [ "object", "null" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "isAnonymous" : { "type" : [ "boolean", "null" ] }, "accountCount" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "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))" }, "isEndUser" : { "type" : [ "boolean", "null" ] }, "zohoCRMContact" : { "$ref" : "#/components/schemas/zohoCRMContact" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "customerHappiness" : { "$ref" : "#/components/schemas/customerHappiness" }, "isSpam" : { "type" : [ "boolean", "null" ] } }, "required" : [ "accountCount", "createdTime", "customerHappiness", "id", "isAnonymous", "isEndUser", "isSpam", "photoURL", "webUrl", "zohoCRMContact" ], "additionalProperties" : false }, { "type" : [ "object" ], "required" : [ "accountId", "email", "firstName", "lastName", "mobile", "ownerId", "phone", "secondaryEmail", "type" ] }, { "$ref" : "./Contact.json#/components/schemas/commonJson" }, { "type" : [ "null", "object" ], "properties" : { "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "isAnonymous" : { "type" : [ "boolean", "null" ] }, "accountCount" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "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))" }, "isEndUser" : { "type" : [ "boolean", "null" ] }, "zohoCRMContact" : { "$ref" : "./Contact.json#/components/schemas/zohoCRMContact" }, "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "customerHappiness" : { "$ref" : "./Contact.json#/components/schemas/customerHappiness" }, "isSpam" : { "type" : [ "boolean", "null" ] } }, "required" : [ "accountCount", "createdTime", "customerHappiness", "id", "isAnonymous", "isEndUser", "isSpam", "photoURL", "webUrl", "zohoCRMContact" ] }, { "type" : "object", "required" : [ "accountId", "email", "firstName", "lastName", "mobile", "ownerId", "phone", "secondaryEmail", "type" ] } ] }, "data" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/listViewObject" } }, "long_array" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "customerHappinessCount" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "badCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "goodCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "okCount" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "badCount", "goodCount", "okCount" ] }, "contactjson" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJson" }, { "type" : [ "object", "null" ], "properties" : { "zip" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "country" : { "type" : [ "string", "null" ], "maxLength" : 30 }, "twitter" : { "type" : [ "string", "null" ], "maxLength" : 100, "description" : "Twitter ID of the contact" }, "cf" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "city" : { "type" : [ "string", "null" ], "maxLength" : 30 }, "customFields" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "street" : { "type" : [ "string", "null" ], "maxLength" : 250 }, "facebook" : { "type" : [ "string", "null" ], "maxLength" : 100 }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "description" : { "type" : [ "string", "null" ], "maxLength" : 65535 }, "state" : { "type" : [ "string", "null" ], "maxLength" : 30 }, "title" : { "type" : [ "string", "null" ], "maxLength" : 100 } }, "required" : [ "cf", "city", "country", "customFields", "description", "facebook", "mobile", "state", "street", "title", "twitter", "zip" ], "additionalProperties" : false }, { "$ref" : "./Contact.json#/components/schemas/commonJson" }, { "type" : [ "null", "object" ], "properties" : { "zip" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" }, "country" : { "type" : [ "string", "null" ], "maxLength" : 30 }, "twitter" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "cf" : { "type" : [ "null", "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "city" : { "type" : [ "string", "null" ], "maxLength" : 30 }, "customFields" : { "type" : [ "null", "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "street" : { "type" : [ "string", "null" ], "maxLength" : 250 }, "facebook" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "mobile" : { "type" : [ "string", "null" ], "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "description" : { "type" : [ "string", "null" ], "maxLength" : 65535 }, "state" : { "type" : [ "string", "null" ], "maxLength" : 30 }, "title" : { "type" : [ "string", "null" ], "maxLength" : 100 } }, "required" : [ "cf", "city", "country", "customFields", "description", "facebook", "mobile", "state", "street", "title", "twitter", "zip" ] } ] }, "sourceValues" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "zip" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "lastName" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "country" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "secondaryEmail" : { "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]+)" } } }, "facebook" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "mobile" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "description" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "type" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "title" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "firstName" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "accountId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "twitter" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "phone" : { "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]+)" }, "email" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "language" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "accountId", "cf", "city", "country", "customFields", "description", "email", "facebook", "firstName", "lastName", "mobile", "phone", "secondaryEmail", "state", "street", "title", "twitter", "type", "zip" ] }, "mappingInfo" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "mappingId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "mappingType" : { "type" : [ "string", "null" ], "enum" : [ "PRIMARY", "SECONDARY" ], "maxLength" : 100 }, "isAccountTicketsViewable" : { "type" : [ "boolean", "null" ] } }, "required" : [ "isAccountTicketsViewable", "mappingId", "mappingType" ] }, "listViewObjectWithMappingInfo" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/listViewObject" }, { "type" : [ "object", "null" ], "properties" : { "mappingInfo" : { "$ref" : "#/components/schemas/mappingInfo" } }, "required" : [ "mappingInfo" ], "additionalProperties" : false }, { "$ref" : "./Contact.json#/components/schemas/listViewObject" }, { "type" : [ "null", "object" ], "properties" : { "mappingInfo" : { "$ref" : "./Contact.json#/components/schemas/mappingInfo" } }, "required" : [ "mappingInfo" ] } ] }, "dataWithMappingInfo" : { "type" : [ "array", "null" ], "items" : { "$ref" : "#/components/schemas/listViewObjectWithMappingInfo" } } }, "responses" : { "contactListViewArray" : { "description" : "contactListViewArray 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" : [ { "lastName" : "Case", "secondaryEmail" : null, "mobile" : "+1 5550100123", "ownerId" : null, "type" : null, "accountId" : "1892000000091433", "firstName" : "Jonathan", "photoURL" : "https://desk.zoho.com/api/v1/contacts/1892000000772003/photo", "isAnonymous" : false, "phone" : "+1 5550100123", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1507813910000, "isEndUser" : false, "zohoCRMContact" : null, "id" : "1892000000772003", "customerHappiness" : { "badPercentage" : "0", "okPercentage" : "0", "goodPercentage" : "0" }, "isSpam" : false, "email" : "case@zylker.com" }, { "lastName" : "Jade", "secondaryEmail" : null, "mobile" : null, "ownerId" : null, "type" : null, "accountId" : "1892000000052077", "firstName" : "Christ", "photoURL" : null, "isAnonymous" : false, "phone" : null, "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1507813910000, "isEndUser" : false, "zohoCRMContact" : { "id" : "1892000000772030", "type" : [ "contacts_leads" ] }, "id" : "1892000000772001", "customerHappiness" : { "badPercentage" : "22", "okPercentage" : "31", "goodPercentage" : "47" }, "isSpam" : false, "email" : "jade@zylker.com" }, { "lastName" : "Jade", "secondaryEmail" : null, "mobile" : null, "ownerId" : null, "type" : null, "accountId" : "1892000000052077", "firstName" : "Christ", "photoURL" : null, "isAnonymous" : false, "phone" : null, "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1507813910000, "isEndUser" : false, "zohoCRMContact" : { "id" : "1892000000772030", "type" : "contacts_leads" }, "id" : "1892000000772001", "customerHappiness" : { "badPercentage" : "22", "okPercentage" : "31", "goodPercentage" : "47" }, "isSpam" : false, "email" : "jade@zylker.com" } ] } } } } } }, "getStatistics" : { "description" : "getStatistics template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstResponseTime" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "openTickets" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "responseTime" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "spamTickets" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "totalTickets" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "customerHappiness" : { "$ref" : "#/components/schemas/customerHappinessCount" }, "resolutionTime" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "closedTickets" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "channelWiseCount" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9]+)" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } } }, "escalatedTickets" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "onholdTickets" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "overdueTickets" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "channelWiseCount", "closedTickets", "customerHappiness", "escalatedTickets", "firstResponseTime", "onholdTickets", "openTickets", "overdueTickets", "resolutionTime", "responseTime", "spamTickets", "totalTickets" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "firstResponseTime" : "120000", "openTickets" : "11", "responseTime" : "13150000", "spamTickets" : "0", "totalTickets" : "36", "customerHappiness" : { "badCount" : "50", "goodCount" : "0", "okCount" : "50" }, "closedTickets" : "23", "resolutionTime" : "0", "channelWiseCount" : { "Web" : "12", "Forums" : "14", "Chat" : "10" }, "onholdTickets" : "2", "escalatedTickets" : "0", "overdueTickets" : "0" } } } } } }, "countJson" : { "description" : "countJson template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "count" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "count" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "count" : "10" } } } } } }, "contactResponse" : { "description" : "contactResponse template definitions", "content" : { "application/json" : { "schema" : { "allOf" : [ { "type" : [ "object" ], "properties" : { "owner" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50 }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50 }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "firstName", "id", "lastName" ] }, "account" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "website" : { "type" : [ "string", "null" ], "maxLength" : 120 }, "accountName" : { "type" : [ "string", "null" ], "maxLength" : 200 }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "accountName", "id", "website" ] } }, "additionalProperties" : false }, { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/contactjson" }, { "type" : [ "object", "null" ], "properties" : { "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "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))" }, "cf" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "isFollowing" : { "type" : [ "boolean", "null" ] }, "accountCount" : { "type" : [ "string", "integer", "null" ], "format" : "int32", "pattern" : "([0-9]+)" }, "customFields" : { "type" : [ "object", "null" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "layoutId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "isAnonymous" : { "type" : [ "boolean", "null" ] }, "isDeleted" : { "type" : [ "boolean", "null" ] }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "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))" }, "isEndUser" : { "type" : [ "boolean", "null" ] }, "zohoCRMContact" : { "$ref" : "#/components/schemas/zohoCRMContact" }, "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "customerHappiness" : { "$ref" : "#/components/schemas/customerHappiness" }, "isSpam" : { "type" : [ "boolean", "null" ] }, "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, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "required" : [ "id", "layoutName" ] } }, "required" : [ "accountCount", "cf", "createdTime", "customFields", "customerHappiness", "id", "isAnonymous", "isDeleted", "isEndUser", "isFollowing", "isSpam", "isTrashed", "layoutDetails", "layoutId", "modifiedTime", "photoURL", "webUrl", "zohoCRMContact" ], "additionalProperties" : false } ] }, { "type" : "object", "properties" : { "owner" : { "type" : [ "null", "object" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "firstName" : { "type" : [ "string", "null" ], "maxLength" : 50 }, "lastName" : { "type" : [ "string", "null" ], "maxLength" : 50 }, "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "firstName", "id", "lastName" ] }, "account" : { "type" : [ "null", "object" ], "additionalProperties" : false, "maxProperties" : 3, "minProperties" : 3, "properties" : { "website" : { "type" : [ "string", "null" ], "maxLength" : 120 }, "accountName" : { "type" : [ "string", "null" ], "maxLength" : 200 }, "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "accountName", "id", "website" ] } } }, { "additionalProperties" : false, "allOf" : [ { "$ref" : "./Contact.json#/components/schemas/contactjson" }, { "type" : [ "null", "object" ], "properties" : { "modifiedTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "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))" }, "cf" : { "type" : [ "null", "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "isFollowing" : { "type" : [ "boolean", "null" ] }, "accountCount" : { "type" : [ "string", "null", "integer" ], "format" : "int32", "pattern" : "([0-9]+)" }, "customFields" : { "type" : [ "null", "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "layoutId" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "photoURL" : { "type" : [ "string", "null" ], "maxLength" : 100, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "isAnonymous" : { "type" : [ "boolean", "null" ] }, "isDeleted" : { "type" : [ "boolean", "null" ] }, "isTrashed" : { "type" : [ "boolean", "null" ] }, "webUrl" : { "type" : [ "string", "null" ], "maxLength" : 500, "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&%\\$#_@]*)?$)" }, "createdTime" : { "type" : [ "string", "null" ], "maxLength" : 100, "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))" }, "isEndUser" : { "type" : [ "boolean", "null" ] }, "zohoCRMContact" : { "$ref" : "./Contact.json#/components/schemas/zohoCRMContact" }, "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "customerHappiness" : { "$ref" : "./Contact.json#/components/schemas/customerHappiness" }, "isSpam" : { "type" : [ "boolean", "null" ] }, "layoutDetails" : { "type" : [ "null", "object" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "id" : { "type" : [ "string", "null", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "layoutName" : { "type" : [ "string", "null" ], "maxLength" : 120, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } }, "required" : [ "id", "layoutName" ] } }, "required" : [ "accountCount", "cf", "createdTime", "customFields", "customerHappiness", "id", "isAnonymous", "isDeleted", "isEndUser", "isFollowing", "isSpam", "isTrashed", "layoutDetails", "layoutId", "modifiedTime", "photoURL", "webUrl", "zohoCRMContact" ] } ] } ] }, "examples" : { "Valid responses Definitions" : { "value" : { "lastName" : "Lawrence", "modifiedTime" : 1462355837000, "country" : null, "secondaryEmail" : null, "city" : null, "description" : null, "ownerId" : "1892000000042001", "type" : null, "title" : null, "photoURL" : "https://desk.zoho.com/api/v1/contacts/1892000000042032/photo", "twitter" : null, "isDeleted" : false, "isTrashed" : false, "street" : null, "createdTime" : 1383564067000, "zohoCRMContact" : { "id" : "5000000014010", "type" : [ "contacts_leads" ] }, "customerHappiness" : { "badPercentage" : "22", "okPercentage" : "31", "goodPercentage" : "47" }, "state" : null, "id" : "1892000000042032", "email" : "lawrence@zylker.com", "zip" : null, "owner" : { "firstName" : "Twin", "lastName" : "john", "id" : "1892000000042001" }, "cf" : { "cf_permanentaddress" : null, "cf_lastcontactedon" : null }, "isFollowing" : "true", "facebook" : null, "mobile" : null, "accountId" : "1892000000975382", "firstName" : "Jennifer", "isAnonymous" : false, "phone" : "+1 5550100123", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "isSpam" : false } } } } } }, "contactListViewArrayWithMappingInfo" : { "description" : "contactListViewArrayWithMappingInfo template definitions", "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "$ref" : "#/components/schemas/dataWithMappingInfo" } }, "required" : [ "data" ] }, "examples" : { "Valid responses Definitions" : { "value" : { "data" : [ { "lastName" : "Lawrence", "secondaryEmail" : null, "mappingInfo" : { "mappingId" : "18026000003237019", "mappingType" : "PRIMARY", "isAccountTicketsViewable" : true }, "mobile" : "+1 5550100123", "type" : null, "ownerId" : "4000000008734", "firstName" : null, "accountId" : "4000000008784", "photoURL" : null, "isAnonymous" : true, "phone" : "+1 5550100123", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1507813910000, "isEndUser" : "false", "zohoCRMContact" : { "id" : "5000000014010", "type" : [ "contacts_leads" ] }, "customerHappiness" : { "badPercentage" : "0", "okPercentage" : "0", "goodPercentage" : "0" }, "id" : "4000000008786", "isSpam" : false, "email" : "support@zylker.com" }, { "lastName" : "Lawrence", "secondaryEmail" : null, "mappingInfo" : { "mappingId" : "18026000003237019", "mappingType" : "PRIMARY", "isAccountTicketsViewable" : true }, "mobile" : "+1 5550100123", "type" : null, "ownerId" : "4000000008734", "firstName" : null, "accountId" : "4000000008784", "photoURL" : null, "isAnonymous" : true, "phone" : "+1 5550100123", "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38", "createdTime" : 1507813910000, "isEndUser" : "false", "zohoCRMContact" : { "id" : "5000000014010", "type" : "contacts_leads" }, "customerHappiness" : { "badPercentage" : "0", "okPercentage" : "0", "goodPercentage" : "0" }, "id" : "4000000008786", "isSpam" : false, "email" : "support@zylker.com" } ] } } } } } } }, "requestBodies" : { "inviteContactsAsEndUser" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "helpCenterId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "contactIds" : { "$ref" : "#/components/schemas/long_array" } }, "required" : [ "contactIds", "helpCenterId" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "helpCenterId" : "4000000021302", "contactIds" : [ "4000000012902", "40000000212902", "40000002129122" ] } } } } } }, "dissociateAccountsWithContact" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "ids" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, "required" : [ "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "ids" : [ "7000000027223", "7000000043968" ] } } } } } }, "deleteContactsRequest" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "contactIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, "required" : [ "contactIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "contactIds" : [ "2000032002145" ] } } } } } }, "contact_massupdate" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "isCustomField" : { "type" : [ "boolean", "null" ] }, "fieldName" : { "type" : [ "string", "null" ], "maxLength" : 320 }, "ids" : { "$ref" : "#/components/schemas/long_array" }, "fieldValue" : { "type" : [ "string", "null" ], "maxLength" : 320 } }, "required" : [ "fieldName", "ids", "fieldValue" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "fieldName" : "mobile", "isCustomField" : false, "ids" : [ "1892000000093303", "1892000000085009", "1892000000050003" ], "fieldValue" : "8508569875" } } } } } }, "contactjson" : { "content" : { "application/json" : { "schema" : { "allOf" : [ { "$ref" : "#/components/schemas/commonJson" }, { "type" : [ "object" ], "properties" : { "zip" : { "type" : [ "string", "integer" ], "format" : "int32", "description" : "Zip code", "pattern" : "([0-9]+)" }, "country" : { "type" : [ "string" ], "description" : "Contact's country of residence", "maxLength" : 100 }, "twitter" : { "type" : [ "string" ], "description" : "Twitter ID of the contact", "maxLength" : 100 }, "cf" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "city" : { "type" : [ "string" ], "description" : "Contact's city of residence", "maxLength" : 100 }, "customFields" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "street" : { "type" : [ "string" ], "description" : "Contact's address", "maxLength" : 250 }, "facebook" : { "type" : [ "string" ], "description" : "Facebook ID of the contact", "maxLength" : 100 }, "mobile" : { "type" : [ "string" ], "description" : "Mobile number of the contact", "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "description" : { "type" : [ "string" ], "description" : "Contact description", "maxLength" : 65535 }, "state" : { "type" : [ "string" ], "description" : "Contact's state of residence", "maxLength" : 100 }, "title" : { "type" : [ "string" ], "description" : "Contact title", "maxLength" : 100 } } }, { "type" : [ "object" ], "properties" : { "layoutId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "language" : { "type" : [ "string" ], "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+", "x-regex-name" : "picklistValue", "maxLength" : 255 } } } ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "zip" : "123902", "lastName" : "Jack", "country" : "USA", "secondaryEmail" : "hughjack@zylker.com", "city" : "Texas", "facebook" : "hugh jacks", "mobile" : "+1 5550100123", "description" : "first priority contact", "ownerId" : "1892000000056007", "type" : [ "paidUser" ], "title" : "The contact", "accountId" : "1892000000052077", "firstName" : "hugh", "twitter" : "Hugh jack", "phone" : "+1 5550100123", "street" : "North street", "state" : "Austin", "email" : "jack@zylker.com" } } } } } }, "updateContact_contactjson" : { "content" : { "application/json" : { "schema" : { "additionalProperties" : false, "allOf" : [ { "$ref" : "#/components/schemas/commonJson" }, { "type" : [ "object" ], "properties" : { "zip" : { "type" : [ "string", "integer" ], "format" : "int32", "description" : "Zip code", "pattern" : "([0-9]+)" }, "country" : { "type" : [ "string" ], "description" : "Contact's country of residence", "maxLength" : 30 }, "twitter" : { "type" : [ "string" ], "description" : "Twitter ID of the contact", "maxLength" : 100 }, "cf" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "city" : { "type" : [ "string" ], "description" : "Contact's city of residence", "maxLength" : 30 }, "customFields" : { "type" : [ "object" ], "additionalProperties" : false, "patternProperties" : { "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : { "type" : [ "string" ], "maxLength" : 100, "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" } } }, "street" : { "type" : [ "string" ], "description" : "Contact's address", "maxLength" : 250 }, "facebook" : { "type" : [ "string" ], "description" : "Facebook ID of the contact", "maxLength" : 100 }, "mobile" : { "type" : [ "string" ], "description" : "Mobile number of the contact", "maxLength" : 50, "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+" }, "description" : { "type" : [ "string" ], "description" : "Contact description", "maxLength" : 65535 }, "state" : { "type" : [ "string" ], "description" : "Contact's state of residence", "maxLength" : 30 }, "title" : { "type" : [ "string" ], "description" : "Contact title", "maxLength" : 100 } }, "additionalProperties" : false }, { "type" : [ "object" ], "properties" : { "layoutId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "language" : { "type" : [ "string" ], "pattern" : "[0-9a-zA-Z_\\-\\.\\$@\\?\\:\\/\\!\\P{InBasicLatin}\\s()]+", "x-regex-name" : "picklistValue", "maxLength" : 255 } } } ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "zip" : "123902", "lastName" : "Jack", "country" : "USA", "secondaryEmail" : "hughjack@zylker.com", "city" : "Texas", "facebook" : "hugh jacks", "mobile" : "+1 5550100123", "description" : "first priority contact", "ownerId" : "1892000000056007", "type" : [ "paidUser" ], "title" : "The contact", "accountId" : "1892000000052077", "firstName" : "hugh", "twitter" : "Hugh jack", "phone" : "+1 5550100123", "street" : "North street", "state" : "Austin", "email" : "jack@zylker.com" } } } } } }, "contactMergeRequest" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "ids" : { "$ref" : "#/components/schemas/long_array" }, "source" : { "$ref" : "#/components/schemas/sourceValues" } }, "required" : [ "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "ids" : [ "4000000018011", "4000000018021" ], "source" : { "zip" : "4000000018011", "lastName" : "4000000018011", "country" : "4000000018011", "secondaryEmail" : "4000000018011", "cf" : { "cf_permanentaddress" : 1892220000042001 }, "city" : "4000000018011", "facebook" : "4000000018011", "mobile" : "+1 5550100123", "description" : "4000000018011", "type" : [ "4000000018011" ], "title" : "4000000018011", "firstName" : "4000000018011", "accountId" : "4000000018011", "twitter" : "4000000018011", "phone" : "+1 5550100123", "street" : "4000000018011", "email" : "4000000018011" } } } } } } }, "updateSignupApproval" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "helpCenterIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, "required" : [ "helpCenterIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "helpCenterIds" : [ "4000000021302" ] } } } } } }, "rejectEndUserInvite_updateSignupApproval" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "helpCenterIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, "required" : [ "helpCenterIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "helpCenterIds" : [ "4000000021302" ] } } } } } }, "associateAccountsWithContact" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "data" : { "type" : [ "array", "null" ], "items" : { "type" : [ "object", "null" ], "additionalProperties" : false, "maxProperties" : 2, "minProperties" : 2, "properties" : { "id" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "isAccountTicketsViewable" : { "type" : [ "boolean", "null" ] } }, "required" : [ "id", "isAccountTicketsViewable" ] }, "uniqueItems" : false }, "ids" : { "type" : [ "array" ], "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" }, "minItems" : 1, "maxItems" : 50 } }, "required" : [ "data" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "data" : [ { "id" : 7000000027223, "isAccountTicketsViewable" : true }, { "id" : 7000000043968, "isAccountTicketsViewable" : false } ] } } } } } }, "associateProductsWithContact" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "departmentId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "ids" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false }, "associate" : { "type" : [ "boolean", "null" ] } }, "required" : [ "associate", "ids" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "departmentId" : "7000000062800", "ids" : [ "7000000027223", "7000000043968" ], "associate" : true } } } } } }, "deleteSpamContacts_deleteContactsRequest" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "contactIds" : { "type" : [ "array", "null" ], "items" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" }, "uniqueItems" : false } }, "required" : [ "contactIds" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "contactIds" : [ "1892000000004507", "1892000000004508" ] } } } } } }, "inviteContactAsEndUser" : { "content" : { "application/json" : { "schema" : { "type" : [ "object", "null" ], "additionalProperties" : false, "properties" : { "helpCenterId" : { "type" : [ "string", "integer", "null" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "required" : [ "helpCenterId" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "helpCenterId" : "4000000021302" } } } } } }, "markSpamContactPayload" : { "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "properties" : { "ids" : { "type" : [ "array" ], "description" : "ID(s) of the contact(s) that must be marked or unmarked as spam", "items" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } }, "isSpam" : { "type" : [ "boolean" ], "description" : "Key that marks or unmarks a single contact or multiple contacts as spam" }, "handleExistingTickets" : { "type" : [ "boolean" ], "description" : "Key that marks or unmarks tickets from the contact(s) as spam" } }, "required" : [ "ids", "isSpam", "handleExistingTickets" ], "additionalProperties" : false }, "examples" : { "Valid requestBody Definitions" : { "value" : { "handleExistingTickets" : "true", "ids" : [ "1000000030065", "1000000030068" ], "isSpam" : "true" } } } } } }, "removeContactAccountMapping" : { "required" : true, "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "properties" : { "option" : { "type" : [ "string" ], "enum" : [ "Move Tickets To Contact", "Move Tickets To Account", "Delete Tickets", "Maintain Same Relationship" ] }, "optionValue" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)" } } } } } }, "updateTicketsAccount" : { "required" : true, "content" : { "application/json" : { "schema" : { "type" : [ "object" ], "additionalProperties" : false, "properties" : { "oldAccountId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the account from which the tickets need to be moved" }, "newAccountId" : { "type" : [ "string", "integer" ], "format" : "int64", "pattern" : "([0-9]+)", "description" : "ID of the account to move the tickets to" } }, "required" : [ "oldAccountId", "newAccountId" ] }, "examples" : { "Valid requestBody Definitions" : { "value" : { "oldAccountId" : 7000000027223, "newAccountId" : 7000000043968 } } } } } } }, "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" : "Contact" }