agent-generator-cli 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (766) hide show
  1. package/README.md +2 -22
  2. package/install-extension.js +89 -0
  3. package/main.js +45 -7
  4. package/package.json +21 -8
  5. package/source/api-data-generators/.idea/api-data-generators.iml +9 -0
  6. package/source/api-data-generators/.idea/misc.xml +6 -0
  7. package/source/api-data-generators/.idea/modules.xml +8 -0
  8. package/source/api-data-generators/.idea/vcs.xml +6 -0
  9. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +318 -0
  10. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +32 -0
  11. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +21 -0
  12. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +18 -0
  13. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +39 -0
  14. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +157 -0
  15. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +46 -0
  16. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +16 -0
  17. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +33 -0
  18. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +13 -0
  19. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +91 -0
  20. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +18 -0
  21. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +42 -0
  22. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +92 -0
  23. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +51 -0
  24. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +11 -0
  25. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +41 -0
  26. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +18 -0
  27. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +76 -0
  28. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +51 -0
  29. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +25 -0
  30. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +26 -0
  31. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +18 -0
  32. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +17 -0
  33. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +17 -0
  34. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +21 -0
  35. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +32 -0
  36. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +43 -0
  37. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +631 -0
  38. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +70 -0
  39. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +294 -0
  40. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +58 -0
  41. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +74 -0
  42. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +11 -0
  43. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +24 -0
  44. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +259 -0
  45. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +6 -0
  46. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +14 -0
  47. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +19 -0
  48. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +265 -0
  49. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +48 -0
  50. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +47 -0
  51. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +14 -0
  52. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +52 -0
  53. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +33 -0
  54. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +45 -0
  55. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +38 -0
  56. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +50 -0
  57. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +22 -0
  58. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +217 -0
  59. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +30 -0
  60. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +31 -0
  61. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +36 -0
  62. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +32 -0
  63. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +49 -0
  64. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +66 -0
  65. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +294 -0
  66. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +150 -0
  67. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +238 -0
  68. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +147 -0
  69. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +56 -0
  70. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +397 -0
  71. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +1123 -0
  72. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +26 -0
  73. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +26 -0
  74. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +49 -0
  75. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +58 -0
  76. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +27 -0
  77. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +20 -0
  78. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +13 -0
  79. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +24 -0
  80. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +29 -0
  81. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +115 -0
  82. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +64 -0
  83. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +288 -0
  84. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +119 -0
  85. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +37 -0
  86. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +26 -0
  87. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +211 -0
  88. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +40 -0
  89. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +32 -0
  90. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +72 -0
  91. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +247 -0
  92. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +51 -0
  93. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +65 -0
  94. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +77 -0
  95. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +14 -0
  96. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +44 -0
  97. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +35 -0
  98. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +185 -0
  99. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +43 -0
  100. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +313 -0
  101. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +16 -0
  102. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +121 -0
  103. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +350 -0
  104. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +16 -0
  105. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +19 -0
  106. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +509 -0
  107. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +32 -0
  108. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +63 -0
  109. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +370 -0
  110. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +44 -0
  111. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +47 -0
  112. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +52 -0
  113. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +11 -0
  114. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +45 -0
  115. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +184 -0
  116. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +30 -0
  117. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +93 -0
  118. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +19 -0
  119. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +202 -0
  120. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +56 -0
  121. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +334 -0
  122. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +113 -0
  123. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +68 -0
  124. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +16 -0
  125. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +270 -0
  126. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +70 -0
  127. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +486 -0
  128. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +77 -0
  129. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +305 -0
  130. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +126 -0
  131. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +205 -0
  132. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +90 -0
  133. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +33 -0
  134. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +228 -0
  135. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +44 -0
  136. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +156 -0
  137. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +50 -0
  138. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +17 -0
  139. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +37 -0
  140. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +45 -0
  141. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +6 -0
  142. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +21 -0
  143. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +106 -0
  144. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +205 -0
  145. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +196 -0
  146. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +45 -0
  147. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +77 -0
  148. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +14 -0
  149. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +689 -0
  150. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +64 -0
  151. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +61 -0
  152. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +49 -0
  153. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +44 -0
  154. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +108 -0
  155. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +39 -0
  156. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +54 -0
  157. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +1031 -0
  158. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +564 -0
  159. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +36 -0
  160. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +180 -0
  161. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +60 -0
  162. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +26 -0
  163. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +240 -0
  164. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +16 -0
  165. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +216 -0
  166. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +168 -0
  167. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +29 -0
  168. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +98 -0
  169. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +11 -0
  170. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +93 -0
  171. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +34 -0
  172. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +18 -0
  173. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +25 -0
  174. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +65 -0
  175. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +155 -0
  176. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +92 -0
  177. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +22 -0
  178. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +19 -0
  179. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +143 -0
  180. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +39 -0
  181. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +312 -0
  182. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +35 -0
  183. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +16 -0
  184. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +32 -0
  185. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +297 -0
  186. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +38 -0
  187. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +56 -0
  188. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +149 -0
  189. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +77 -0
  190. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +52 -0
  191. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +229 -0
  192. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +16 -0
  193. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +90 -0
  194. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +25 -0
  195. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +66 -0
  196. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +49 -0
  197. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +23 -0
  198. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +131 -0
  199. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +214 -0
  200. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +30 -0
  201. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +173 -0
  202. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +21 -0
  203. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +93 -0
  204. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +103 -0
  205. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +503 -0
  206. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +19 -0
  207. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +334 -0
  208. package/source/api-data-generators/support/License/test_data_generation_configurations.json +60 -0
  209. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +72 -0
  210. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +34 -0
  211. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +184 -0
  212. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +32 -0
  213. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +38 -0
  214. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +38 -0
  215. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +50 -0
  216. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +16 -0
  217. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +96 -0
  218. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +26 -0
  219. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +19 -0
  220. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +20 -0
  221. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +27 -0
  222. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +19 -0
  223. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +29 -0
  224. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +79 -0
  225. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +109 -0
  226. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +66 -0
  227. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +113 -0
  228. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +28 -0
  229. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +17 -0
  230. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +54 -0
  231. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +54 -0
  232. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +77 -0
  233. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +14 -0
  234. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +32 -0
  235. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +66 -0
  236. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +64 -0
  237. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +32 -0
  238. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +196 -0
  239. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +48 -0
  240. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +59 -0
  241. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +37 -0
  242. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +239 -0
  243. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +52 -0
  244. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +52 -0
  245. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +538 -0
  246. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +28 -0
  247. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +100 -0
  248. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +29 -0
  249. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +84 -0
  250. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +58 -0
  251. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +50 -0
  252. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +29 -0
  253. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +22 -0
  254. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +42 -0
  255. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +92 -0
  256. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +46 -0
  257. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +50 -0
  258. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +22 -0
  259. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +203 -0
  260. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +172 -0
  261. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +182 -0
  262. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +636 -0
  263. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +32 -0
  264. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +32 -0
  265. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +62 -0
  266. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +24 -0
  267. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +164 -0
  268. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +21 -0
  269. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +60 -0
  270. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +51 -0
  271. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +40 -0
  272. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +47 -0
  273. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +22 -0
  274. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +223 -0
  275. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +22 -0
  276. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +76 -0
  277. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +104 -0
  278. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +43 -0
  279. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +65 -0
  280. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +29 -0
  281. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +97 -0
  282. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +219 -0
  283. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +42 -0
  284. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +45 -0
  285. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +87 -0
  286. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +27 -0
  287. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +115 -0
  288. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +72 -0
  289. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +383 -0
  290. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +694 -0
  291. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +66 -0
  292. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +58 -0
  293. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +82 -0
  294. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +43 -0
  295. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +65 -0
  296. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +16 -0
  297. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +99 -0
  298. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +475 -0
  299. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +110 -0
  300. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +48 -0
  301. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +91 -0
  302. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +46 -0
  303. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +68 -0
  304. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +54 -0
  305. package/source/api-data-generators/support/User/test_data_generation_configurations.json +100 -0
  306. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +49 -0
  307. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +19 -0
  308. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +19 -0
  309. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +321 -0
  310. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +501 -0
  311. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +166 -0
  312. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +26 -0
  313. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +38 -0
  314. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +22 -0
  315. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +19 -0
  316. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +22 -0
  317. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +33 -0
  318. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +71 -0
  319. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +859 -0
  320. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +26 -0
  321. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +652 -0
  322. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +21 -0
  323. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +50 -0
  324. package/source/openapi-specifications/v1.0/common/Common.json +587 -0
  325. package/source/openapi-specifications/v1.0/portal/Account.json +183 -0
  326. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +1103 -0
  327. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +133 -0
  328. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +712 -0
  329. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +91 -0
  330. package/source/openapi-specifications/v1.0/portal/Attachment.json +122 -0
  331. package/source/openapi-specifications/v1.0/portal/Captcha.json +334 -0
  332. package/source/openapi-specifications/v1.0/portal/Category.json +1061 -0
  333. package/source/openapi-specifications/v1.0/portal/Comment.json +1546 -0
  334. package/source/openapi-specifications/v1.0/portal/Community.json +235 -0
  335. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +296 -0
  336. package/source/openapi-specifications/v1.0/portal/Contact.json +536 -0
  337. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +163 -0
  338. package/source/openapi-specifications/v1.0/portal/Department.json +246 -0
  339. package/source/openapi-specifications/v1.0/portal/Extension.json +1122 -0
  340. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +96 -0
  341. package/source/openapi-specifications/v1.0/portal/Field.json +1239 -0
  342. package/source/openapi-specifications/v1.0/portal/FileExport.json +313 -0
  343. package/source/openapi-specifications/v1.0/portal/Followers.json +802 -0
  344. package/source/openapi-specifications/v1.0/portal/Gamification.json +819 -0
  345. package/source/openapi-specifications/v1.0/portal/HashTags.json +61 -0
  346. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +605 -0
  347. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +148 -0
  348. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +920 -0
  349. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +118 -0
  350. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +184 -0
  351. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +70 -0
  352. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +1310 -0
  353. package/source/openapi-specifications/v1.0/portal/KbCategory.json +1525 -0
  354. package/source/openapi-specifications/v1.0/portal/KbSection.json +515 -0
  355. package/source/openapi-specifications/v1.0/portal/Label.json +172 -0
  356. package/source/openapi-specifications/v1.0/portal/Layout.json +303 -0
  357. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +375 -0
  358. package/source/openapi-specifications/v1.0/portal/Mentions.json +580 -0
  359. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +699 -0
  360. package/source/openapi-specifications/v1.0/portal/Permalink.json +265 -0
  361. package/source/openapi-specifications/v1.0/portal/Placeholders.json +57 -0
  362. package/source/openapi-specifications/v1.0/portal/Product.json +401 -0
  363. package/source/openapi-specifications/v1.0/portal/Solution.json +3766 -0
  364. package/source/openapi-specifications/v1.0/portal/Thread.json +821 -0
  365. package/source/openapi-specifications/v1.0/portal/Ticket.json +2636 -0
  366. package/source/openapi-specifications/v1.0/portal/TicketComment.json +822 -0
  367. package/source/openapi-specifications/v1.0/portal/TicketCount.json +336 -0
  368. package/source/openapi-specifications/v1.0/portal/TicketExport.json +609 -0
  369. package/source/openapi-specifications/v1.0/portal/TicketField.json +358 -0
  370. package/source/openapi-specifications/v1.0/portal/TicketForm.json +517 -0
  371. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +155 -0
  372. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +409 -0
  373. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +175 -0
  374. package/source/openapi-specifications/v1.0/portal/Topic.json +4079 -0
  375. package/source/openapi-specifications/v1.0/portal/Translation.json +174 -0
  376. package/source/openapi-specifications/v1.0/portal/Upload.json +156 -0
  377. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +309 -0
  378. package/source/openapi-specifications/v1.0/portal/View.json +353 -0
  379. package/source/openapi-specifications/v1.0/portal/Widget.json +218 -0
  380. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +354 -0
  381. package/source/openapi-specifications/v1.0/support/Account.json +3206 -0
  382. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +484 -0
  383. package/source/openapi-specifications/v1.0/support/AccountComments.json +794 -0
  384. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +227 -0
  385. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +578 -0
  386. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +350 -0
  387. package/source/openapi-specifications/v1.0/support/AccountSla.json +341 -0
  388. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +1152 -0
  389. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +573 -0
  390. package/source/openapi-specifications/v1.0/support/Activity.json +1400 -0
  391. package/source/openapi-specifications/v1.0/support/Actor.json +88 -0
  392. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +304 -0
  393. package/source/openapi-specifications/v1.0/support/AdminTool.json +489 -0
  394. package/source/openapi-specifications/v1.0/support/Agent.json +6685 -0
  395. package/source/openapi-specifications/v1.0/support/AgentPresence.json +567 -0
  396. package/source/openapi-specifications/v1.0/support/AgentRoom.json +1997 -0
  397. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +359 -0
  398. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +1402 -0
  399. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +510 -0
  400. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +1189 -0
  401. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +543 -0
  402. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +155 -0
  403. package/source/openapi-specifications/v1.0/support/ArchivedView.json +469 -0
  404. package/source/openapi-specifications/v1.0/support/Article.json +5060 -0
  405. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +544 -0
  406. package/source/openapi-specifications/v1.0/support/ArticleComment.json +1929 -0
  407. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +56 -0
  408. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +1314 -0
  409. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +513 -0
  410. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +2510 -0
  411. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +3053 -0
  412. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +7530 -0
  413. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +184 -0
  414. package/source/openapi-specifications/v1.0/support/ArticleViews.json +564 -0
  415. package/source/openapi-specifications/v1.0/support/Asap.json +1525 -0
  416. package/source/openapi-specifications/v1.0/support/AsapModule.json +246 -0
  417. package/source/openapi-specifications/v1.0/support/AsapStatus.json +199 -0
  418. package/source/openapi-specifications/v1.0/support/AssistInteg.json +613 -0
  419. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +786 -0
  420. package/source/openapi-specifications/v1.0/support/AuditLog.json +1122 -0
  421. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +702 -0
  422. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +868 -0
  423. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +1181 -0
  424. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +207 -0
  425. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +809 -0
  426. package/source/openapi-specifications/v1.0/support/AutomationTask.json +1054 -0
  427. package/source/openapi-specifications/v1.0/support/Backup.json +2845 -0
  428. package/source/openapi-specifications/v1.0/support/Badge.json +544 -0
  429. package/source/openapi-specifications/v1.0/support/Bot.json +2103 -0
  430. package/source/openapi-specifications/v1.0/support/BotInference.json +1071 -0
  431. package/source/openapi-specifications/v1.0/support/BotResources.json +175 -0
  432. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +541 -0
  433. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +63 -0
  434. package/source/openapi-specifications/v1.0/support/Bots.json +58 -0
  435. package/source/openapi-specifications/v1.0/support/BugInteg.json +481 -0
  436. package/source/openapi-specifications/v1.0/support/BulkAction.json +150 -0
  437. package/source/openapi-specifications/v1.0/support/BulkImport.json +2845 -0
  438. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +743 -0
  439. package/source/openapi-specifications/v1.0/support/BulkWrite.json +678 -0
  440. package/source/openapi-specifications/v1.0/support/BusinessHour.json +1344 -0
  441. package/source/openapi-specifications/v1.0/support/Call.json +3839 -0
  442. package/source/openapi-specifications/v1.0/support/CallComments.json +721 -0
  443. package/source/openapi-specifications/v1.0/support/CallHistory.json +936 -0
  444. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +1745 -0
  445. package/source/openapi-specifications/v1.0/support/CallTimer.json +285 -0
  446. package/source/openapi-specifications/v1.0/support/Channel.json +730 -0
  447. package/source/openapi-specifications/v1.0/support/Chart.json +422 -0
  448. package/source/openapi-specifications/v1.0/support/ChatTicket.json +553 -0
  449. package/source/openapi-specifications/v1.0/support/ClientAction.json +1834 -0
  450. package/source/openapi-specifications/v1.0/support/ClientEvent.json +780 -0
  451. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +1123 -0
  452. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +528 -0
  453. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +44 -0
  454. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +94 -0
  455. package/source/openapi-specifications/v1.0/support/Community.json +2545 -0
  456. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +249 -0
  457. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +1896 -0
  458. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +145 -0
  459. package/source/openapi-specifications/v1.0/support/CommunityComment.json +2492 -0
  460. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +129 -0
  461. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +343 -0
  462. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +78 -0
  463. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +6005 -0
  464. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +310 -0
  465. package/source/openapi-specifications/v1.0/support/CommunityUser.json +822 -0
  466. package/source/openapi-specifications/v1.0/support/Composite.json +414 -0
  467. package/source/openapi-specifications/v1.0/support/Contact.json +4691 -0
  468. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +484 -0
  469. package/source/openapi-specifications/v1.0/support/ContactComments.json +769 -0
  470. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +683 -0
  471. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +350 -0
  472. package/source/openapi-specifications/v1.0/support/ContactProfile.json +195 -0
  473. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +1157 -0
  474. package/source/openapi-specifications/v1.0/support/Contract.json +2877 -0
  475. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +307 -0
  476. package/source/openapi-specifications/v1.0/support/Conversation.json +570 -0
  477. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +5279 -0
  478. package/source/openapi-specifications/v1.0/support/CreditCycle.json +124 -0
  479. package/source/openapi-specifications/v1.0/support/Criteria.json +1014 -0
  480. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +50 -0
  481. package/source/openapi-specifications/v1.0/support/CrmInteg.json +5938 -0
  482. package/source/openapi-specifications/v1.0/support/CustomAction.json +2106 -0
  483. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +1327 -0
  484. package/source/openapi-specifications/v1.0/support/CustomButton.json +1898 -0
  485. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +883 -0
  486. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +329 -0
  487. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +317 -0
  488. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +379 -0
  489. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +3457 -0
  490. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +81 -0
  491. package/source/openapi-specifications/v1.0/support/CustomTheme.json +7391 -0
  492. package/source/openapi-specifications/v1.0/support/CustomView.json +3478 -0
  493. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +464 -0
  494. package/source/openapi-specifications/v1.0/support/DBThrottle.json +334 -0
  495. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +1163 -0
  496. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +1258 -0
  497. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +2310 -0
  498. package/source/openapi-specifications/v1.0/support/Dashboards.json +1219 -0
  499. package/source/openapi-specifications/v1.0/support/DataChips.json +477 -0
  500. package/source/openapi-specifications/v1.0/support/DataImport.json +1099 -0
  501. package/source/openapi-specifications/v1.0/support/DataSync.json +1246 -0
  502. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +153 -0
  503. package/source/openapi-specifications/v1.0/support/Department.json +1971 -0
  504. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +656 -0
  505. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +232 -0
  506. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +722 -0
  507. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +91 -0
  508. package/source/openapi-specifications/v1.0/support/DomainMapping.json +1143 -0
  509. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +306 -0
  510. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +1491 -0
  511. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +572 -0
  512. package/source/openapi-specifications/v1.0/support/Event.json +3607 -0
  513. package/source/openapi-specifications/v1.0/support/EventComments.json +737 -0
  514. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +1520 -0
  515. package/source/openapi-specifications/v1.0/support/EventTimer.json +285 -0
  516. package/source/openapi-specifications/v1.0/support/Expression.json +43 -0
  517. package/source/openapi-specifications/v1.0/support/Extension.json +7152 -0
  518. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +129 -0
  519. package/source/openapi-specifications/v1.0/support/FAQ.json +142 -0
  520. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +178 -0
  521. package/source/openapi-specifications/v1.0/support/FbManager.json +1147 -0
  522. package/source/openapi-specifications/v1.0/support/Feature.json +691 -0
  523. package/source/openapi-specifications/v1.0/support/FeatureFile.json +435 -0
  524. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +576 -0
  525. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +492 -0
  526. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +318 -0
  527. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +198 -0
  528. package/source/openapi-specifications/v1.0/support/Field.json +7493 -0
  529. package/source/openapi-specifications/v1.0/support/FieldDetails.json +139 -0
  530. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +113 -0
  531. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +3831 -0
  532. package/source/openapi-specifications/v1.0/support/FileExport.json +324 -0
  533. package/source/openapi-specifications/v1.0/support/Finance.json +4290 -0
  534. package/source/openapi-specifications/v1.0/support/Followers.json +875 -0
  535. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +47 -0
  536. package/source/openapi-specifications/v1.0/support/GC_Bots.json +138 -0
  537. package/source/openapi-specifications/v1.0/support/GC_Guide.json +1536 -0
  538. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +58 -0
  539. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +79 -0
  540. package/source/openapi-specifications/v1.0/support/GC_Guides.json +89 -0
  541. package/source/openapi-specifications/v1.0/support/GC_Info.json +208 -0
  542. package/source/openapi-specifications/v1.0/support/GC_Status.json +69 -0
  543. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +79 -0
  544. package/source/openapi-specifications/v1.0/support/GenericAction.json +1888 -0
  545. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +1050 -0
  546. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +1715 -0
  547. package/source/openapi-specifications/v1.0/support/GoogleChat.json +650 -0
  548. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +44 -0
  549. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +900 -0
  550. package/source/openapi-specifications/v1.0/support/Helpcenter.json +1212 -0
  551. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +331 -0
  552. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +1496 -0
  553. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +504 -0
  554. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +208 -0
  555. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +64 -0
  556. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +211 -0
  557. package/source/openapi-specifications/v1.0/support/HolidayList.json +731 -0
  558. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +1091 -0
  559. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +1357 -0
  560. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +169 -0
  561. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +624 -0
  562. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +597 -0
  563. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +841 -0
  564. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +64 -0
  565. package/source/openapi-specifications/v1.0/support/IM_Bot.json +1007 -0
  566. package/source/openapi-specifications/v1.0/support/IM_BotService.json +357 -0
  567. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +323 -0
  568. package/source/openapi-specifications/v1.0/support/IM_Channel.json +2849 -0
  569. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +502 -0
  570. package/source/openapi-specifications/v1.0/support/IM_Contact.json +165 -0
  571. package/source/openapi-specifications/v1.0/support/IM_Efc.json +188 -0
  572. package/source/openapi-specifications/v1.0/support/IM_Integration.json +1269 -0
  573. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +454 -0
  574. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +625 -0
  575. package/source/openapi-specifications/v1.0/support/IM_License.json +225 -0
  576. package/source/openapi-specifications/v1.0/support/IM_Message.json +1371 -0
  577. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +462 -0
  578. package/source/openapi-specifications/v1.0/support/IM_Search.json +547 -0
  579. package/source/openapi-specifications/v1.0/support/IM_Session.json +1397 -0
  580. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +142 -0
  581. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +83 -0
  582. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +86 -0
  583. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +73 -0
  584. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +435 -0
  585. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +202 -0
  586. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +193 -0
  587. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +489 -0
  588. package/source/openapi-specifications/v1.0/support/Import.json +1844 -0
  589. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +395 -0
  590. package/source/openapi-specifications/v1.0/support/Inference.json +307 -0
  591. package/source/openapi-specifications/v1.0/support/InlineImage.json +97 -0
  592. package/source/openapi-specifications/v1.0/support/IntegModule.json +938 -0
  593. package/source/openapi-specifications/v1.0/support/Integrations.json +1264 -0
  594. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +539 -0
  595. package/source/openapi-specifications/v1.0/support/JWT.json +535 -0
  596. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +208 -0
  597. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +241 -0
  598. package/source/openapi-specifications/v1.0/support/KBPreference.json +323 -0
  599. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +2316 -0
  600. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +2839 -0
  601. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +570 -0
  602. package/source/openapi-specifications/v1.0/support/KBSection.json +1941 -0
  603. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +169 -0
  604. package/source/openapi-specifications/v1.0/support/KPIWidget.json +206 -0
  605. package/source/openapi-specifications/v1.0/support/KbBot.json +511 -0
  606. package/source/openapi-specifications/v1.0/support/KbCategory.json +1618 -0
  607. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +124 -0
  608. package/source/openapi-specifications/v1.0/support/Label.json +1251 -0
  609. package/source/openapi-specifications/v1.0/support/Layout.json +8042 -0
  610. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +491 -0
  611. package/source/openapi-specifications/v1.0/support/LayoutRules.json +1422 -0
  612. package/source/openapi-specifications/v1.0/support/LensInteg.json +86 -0
  613. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +548 -0
  614. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +1231 -0
  615. package/source/openapi-specifications/v1.0/support/LicenseTool.json +165 -0
  616. package/source/openapi-specifications/v1.0/support/Livecall.json +954 -0
  617. package/source/openapi-specifications/v1.0/support/LookupRecord.json +174 -0
  618. package/source/openapi-specifications/v1.0/support/Macros.json +1960 -0
  619. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +1263 -0
  620. package/source/openapi-specifications/v1.0/support/MassAction.json +1151 -0
  621. package/source/openapi-specifications/v1.0/support/MassActionError.json +55 -0
  622. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +89 -0
  623. package/source/openapi-specifications/v1.0/support/Mentions.json +491 -0
  624. package/source/openapi-specifications/v1.0/support/Message.json +685 -0
  625. package/source/openapi-specifications/v1.0/support/Microsoft.json +887 -0
  626. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +574 -0
  627. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +903 -0
  628. package/source/openapi-specifications/v1.0/support/Misc.json +214 -0
  629. package/source/openapi-specifications/v1.0/support/Module.json +1625 -0
  630. package/source/openapi-specifications/v1.0/support/NewCriteria.json +1863 -0
  631. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +204 -0
  632. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +150 -0
  633. package/source/openapi-specifications/v1.0/support/NotificationRules.json +441 -0
  634. package/source/openapi-specifications/v1.0/support/OEmbedData.json +233 -0
  635. package/source/openapi-specifications/v1.0/support/Onboarding.json +282 -0
  636. package/source/openapi-specifications/v1.0/support/Organization.json +1391 -0
  637. package/source/openapi-specifications/v1.0/support/PBGroup.json +634 -0
  638. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +433 -0
  639. package/source/openapi-specifications/v1.0/support/PBPlatform.json +1447 -0
  640. package/source/openapi-specifications/v1.0/support/PBX.json +550 -0
  641. package/source/openapi-specifications/v1.0/support/PBXConfig.json +219 -0
  642. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +443 -0
  643. package/source/openapi-specifications/v1.0/support/PBXPreference.json +314 -0
  644. package/source/openapi-specifications/v1.0/support/PageSense.json +1505 -0
  645. package/source/openapi-specifications/v1.0/support/PendingApproval.json +279 -0
  646. package/source/openapi-specifications/v1.0/support/Permalink.json +393 -0
  647. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +1014 -0
  648. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +118 -0
  649. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +1115 -0
  650. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +232 -0
  651. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +499 -0
  652. package/source/openapi-specifications/v1.0/support/Product.json +1861 -0
  653. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +485 -0
  654. package/source/openapi-specifications/v1.0/support/Profile.json +4236 -0
  655. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +989 -0
  656. package/source/openapi-specifications/v1.0/support/QueryStore.json +238 -0
  657. package/source/openapi-specifications/v1.0/support/QueueView.json +335 -0
  658. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +1204 -0
  659. package/source/openapi-specifications/v1.0/support/Records.json +1509 -0
  660. package/source/openapi-specifications/v1.0/support/Recyclebin.json +669 -0
  661. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +401 -0
  662. package/source/openapi-specifications/v1.0/support/Report.json +6491 -0
  663. package/source/openapi-specifications/v1.0/support/ReportChart.json +254 -0
  664. package/source/openapi-specifications/v1.0/support/ReportFolder.json +1076 -0
  665. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +202 -0
  666. package/source/openapi-specifications/v1.0/support/RequestFlags.json +358 -0
  667. package/source/openapi-specifications/v1.0/support/Resources.json +335 -0
  668. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +128 -0
  669. package/source/openapi-specifications/v1.0/support/Role.json +996 -0
  670. package/source/openapi-specifications/v1.0/support/RoundRobin.json +796 -0
  671. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +381 -0
  672. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +615 -0
  673. package/source/openapi-specifications/v1.0/support/RuleGroup.json +1630 -0
  674. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +227 -0
  675. package/source/openapi-specifications/v1.0/support/Saml.json +565 -0
  676. package/source/openapi-specifications/v1.0/support/Sandbox.json +1075 -0
  677. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +501 -0
  678. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +428 -0
  679. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +295 -0
  680. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +268 -0
  681. package/source/openapi-specifications/v1.0/support/SavedFilters.json +652 -0
  682. package/source/openapi-specifications/v1.0/support/Schedule.json +2077 -0
  683. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +2271 -0
  684. package/source/openapi-specifications/v1.0/support/Search.json +12600 -0
  685. package/source/openapi-specifications/v1.0/support/SearchInteg.json +2254 -0
  686. package/source/openapi-specifications/v1.0/support/Setup.json +1766 -0
  687. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +1110 -0
  688. package/source/openapi-specifications/v1.0/support/SharingRule.json +287 -0
  689. package/source/openapi-specifications/v1.0/support/Signature.json +354 -0
  690. package/source/openapi-specifications/v1.0/support/Skill.json +2164 -0
  691. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +269 -0
  692. package/source/openapi-specifications/v1.0/support/SkillType.json +807 -0
  693. package/source/openapi-specifications/v1.0/support/Slack.json +957 -0
  694. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +514 -0
  695. package/source/openapi-specifications/v1.0/support/Snippets.json +918 -0
  696. package/source/openapi-specifications/v1.0/support/SocialBrands.json +427 -0
  697. package/source/openapi-specifications/v1.0/support/SocialInteg.json +336 -0
  698. package/source/openapi-specifications/v1.0/support/SocialPosts.json +2460 -0
  699. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +337 -0
  700. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +690 -0
  701. package/source/openapi-specifications/v1.0/support/Statistics.json +125 -0
  702. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +2419 -0
  703. package/source/openapi-specifications/v1.0/support/Supervise.json +774 -0
  704. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +188 -0
  705. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +293 -0
  706. package/source/openapi-specifications/v1.0/support/SupportPlan.json +1109 -0
  707. package/source/openapi-specifications/v1.0/support/Tab.json +606 -0
  708. package/source/openapi-specifications/v1.0/support/Target.json +1311 -0
  709. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +130 -0
  710. package/source/openapi-specifications/v1.0/support/Task.json +4006 -0
  711. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +443 -0
  712. package/source/openapi-specifications/v1.0/support/TaskComments.json +706 -0
  713. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +1756 -0
  714. package/source/openapi-specifications/v1.0/support/TaskTimer.json +441 -0
  715. package/source/openapi-specifications/v1.0/support/Team.json +1383 -0
  716. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +1069 -0
  717. package/source/openapi-specifications/v1.0/support/Theme.json +152 -0
  718. package/source/openapi-specifications/v1.0/support/Thread.json +3545 -0
  719. package/source/openapi-specifications/v1.0/support/Ticket.json +9495 -0
  720. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +855 -0
  721. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +562 -0
  722. package/source/openapi-specifications/v1.0/support/TicketComment.json +1444 -0
  723. package/source/openapi-specifications/v1.0/support/TicketCount.json +690 -0
  724. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +454 -0
  725. package/source/openapi-specifications/v1.0/support/TicketHistory.json +414 -0
  726. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +369 -0
  727. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +178 -0
  728. package/source/openapi-specifications/v1.0/support/TicketTag.json +1513 -0
  729. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +907 -0
  730. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +1681 -0
  731. package/source/openapi-specifications/v1.0/support/TicketTimer.json +1205 -0
  732. package/source/openapi-specifications/v1.0/support/TimeTracking.json +1212 -0
  733. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +614 -0
  734. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +163 -0
  735. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +2772 -0
  736. package/source/openapi-specifications/v1.0/support/Upload.json +620 -0
  737. package/source/openapi-specifications/v1.0/support/User.json +1409 -0
  738. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +617 -0
  739. package/source/openapi-specifications/v1.0/support/UserPresence.json +763 -0
  740. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +107 -0
  741. package/source/openapi-specifications/v1.0/support/ValidationRules.json +1173 -0
  742. package/source/openapi-specifications/v1.0/support/Webhook.json +1330 -0
  743. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +132 -0
  744. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +143 -0
  745. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +132 -0
  746. package/source/openapi-specifications/v1.0/support/Widget.json +3023 -0
  747. package/source/openapi-specifications/v1.0/support/WmsDomain.json +104 -0
  748. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +756 -0
  749. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +989 -0
  750. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +135 -0
  751. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +376 -0
  752. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +159 -0
  753. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +3229 -0
  754. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +453 -0
  755. package/source/openapi-specifications/v1.0/support/Zwitch.json +1543 -0
  756. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +201 -0
  757. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +75 -0
  758. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +255 -0
  759. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +1677 -0
  760. package/source/openapi-specifications/v1.0/support/blueprintStates.json +284 -0
  761. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +91 -0
  762. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +1546 -0
  763. package/source/openapi-specifications/v1.0/support/blueprints.json +2992 -0
  764. package/source/openapi-specifications/v1.0/support/errors.json +80 -0
  765. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +416 -0
  766. package/.github/agents/Generators.agent.md +0 -121
@@ -0,0 +1,4691 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "Contact",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "contacts",
7
+ "x-module-group" : "contacts"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/products/{productId}/contacts" : {
11
+ "get" : {
12
+ "tags" : [ "Contact" ],
13
+ "summary" : "List contacts associated with product",
14
+ "description" : "This API lists the contacts associated with a product.",
15
+ "operationId" : "getContactsUnderProduct",
16
+ "parameters" : [ {
17
+ "name" : "include",
18
+ "in" : "query",
19
+ "description" : "Key that fetches secondary information related to the contact.Value allowed is @accounts@",
20
+ "required" : false,
21
+ "style" : "simple",
22
+ "explode" : true,
23
+ "schema" : {
24
+ "type" : [ "null", "array" ],
25
+ "description" : "Key that fetches secondary information related to the contact.Value allowed is @accounts@",
26
+ "items" : {
27
+ "type" : [ "string", "null" ],
28
+ "enum" : [ "accounts" ],
29
+ "maxLength" : 100,
30
+ "minLength" : 0,
31
+ "x-custom-parameters-attributes" : [ ]
32
+ },
33
+ "uniqueItems" : true
34
+ }
35
+ }, {
36
+ "$ref" : "#/components/parameters/limit"
37
+ }, {
38
+ "$ref" : "#/components/parameters/from"
39
+ }, {
40
+ "name" : "sortBy",
41
+ "in" : "query",
42
+ "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@phone,@! !@email,@! !@account,@! !@createdTime,@! !@modifiedTime@!",
43
+ "required" : false,
44
+ "style" : "form",
45
+ "explode" : true,
46
+ "schema" : {
47
+ "type" : [ "string", "null" ],
48
+ "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@phone,@! !@email,@! !@account,@! !@createdTime,@! !@modifiedTime@!",
49
+ "enum" : [ "firstName", "lastName", "phone", "email", "account", "createdTime", "modifiedTime" ],
50
+ "maxLength" : 100,
51
+ "minLength" : 0
52
+ }
53
+ }, {
54
+ "$ref" : "#/components/parameters/isSpam"
55
+ }, {
56
+ "name" : "productId",
57
+ "in" : "path",
58
+ "required" : true,
59
+ "style" : "simple",
60
+ "explode" : false,
61
+ "schema" : {
62
+ "type" : [ "string", "null", "integer" ],
63
+ "format" : "int64",
64
+ "pattern" : "([0-9]+)"
65
+ }
66
+ }, {
67
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
68
+ } ],
69
+ "responses" : {
70
+ "204" : {
71
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
72
+ },
73
+ "200" : {
74
+ "$ref" : "#/components/responses/contactListViewArray"
75
+ }
76
+ },
77
+ "security" : [ {
78
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
79
+ }, {
80
+ "iam-oauth2-schema" : [ "Desk.settings.READ", "Desk.contacts.READ" ]
81
+ } ],
82
+ "x-audience" : [ "external-public" ],
83
+ "x-custom-url-attribute" : {
84
+ "security" : {
85
+ "throttle" : {
86
+ "policy" : "ReadAPI_Standard_UserPolicy"
87
+ },
88
+ "extraparams" : {
89
+ "disable" : true,
90
+ "ignore" : false
91
+ },
92
+ "authentication" : {
93
+ "deprecatedScopes" : [ "settings" ]
94
+ }
95
+ },
96
+ "clan-group" : "contacts",
97
+ "apihash" : "5957de99dbd61c7d9766b84326178466",
98
+ "module-group" : "contacts",
99
+ "apimethod" : "com.zoho.support.restapi.ContactService.getContactsUnderProduct"
100
+ }
101
+ }
102
+ },
103
+ "/api/v1/contacts/inviteAsEndUser" : {
104
+ "post" : {
105
+ "tags" : [ "Contact" ],
106
+ "summary" : "Invite multiple contacts to help center",
107
+ "description" : "This API helps invite multiple contacts as end-users to your help center.",
108
+ "operationId" : "inviteContactsAsEndUser",
109
+ "parameters" : [ {
110
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
111
+ } ],
112
+ "requestBody" : {
113
+ "$ref" : "#/components/requestBodies/inviteContactsAsEndUser"
114
+ },
115
+ "responses" : {
116
+ "422" : {
117
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
118
+ },
119
+ "200" : {
120
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
121
+ },
122
+ "403" : {
123
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
124
+ }
125
+ },
126
+ "security" : [ {
127
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
128
+ }, {
129
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
130
+ } ],
131
+ "x-audience" : [ "external-public" ],
132
+ "x-custom-url-attribute" : {
133
+ "security" : {
134
+ "throttle" : {
135
+ "inline" : [ {
136
+ "scope" : "APPSERVER",
137
+ "rules" : [ {
138
+ "duration" : 60000,
139
+ "lock-period" : 600000,
140
+ "threshold" : 20,
141
+ "hip" : false
142
+ }, {
143
+ "duration" : 3600000,
144
+ "lock-period" : 1800000,
145
+ "threshold" : 100,
146
+ "hip" : false
147
+ } ],
148
+ "window" : "ROLLING",
149
+ "key" : "url.path+user.zuid"
150
+ } ]
151
+ },
152
+ "extraparams" : {
153
+ "disable" : true,
154
+ "ignore" : false
155
+ },
156
+ "authentication" : { }
157
+ },
158
+ "clan-group" : "contacts",
159
+ "apihash" : "1c9e5a10f62e640718b4060ff22d37c7",
160
+ "module-group" : "contacts",
161
+ "apimethod" : "com.zoho.support.restapi.ContactService.inviteContactsAsEndUser"
162
+ }
163
+ }
164
+ },
165
+ "/api/v1/contacts/{contactId}/photo" : {
166
+ "get" : {
167
+ "tags" : [ "Contact" ],
168
+ "operationId" : "getContactPhotoStream",
169
+ "parameters" : [ {
170
+ "$ref" : "#/components/parameters/contactId"
171
+ }, {
172
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
173
+ } ],
174
+ "responses" : {
175
+ "204" : {
176
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
177
+ }
178
+ },
179
+ "security" : [ {
180
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
181
+ }, {
182
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
183
+ } ],
184
+ "x-audience" : [ "company-internal" ],
185
+ "x-custom-url-attribute" : {
186
+ "security" : {
187
+ "throttle" : {
188
+ "policy" : "ReadAPI_Standard_UserPolicy"
189
+ },
190
+ "extraparams" : {
191
+ "disable" : true,
192
+ "ignore" : false
193
+ },
194
+ "authentication" : { }
195
+ },
196
+ "clan-group" : "contacts",
197
+ "apihash" : "cb2d36c30ce99f798bf39357e147cb71",
198
+ "module-group" : "contacts",
199
+ "apimethod" : "com.zoho.support.restapi.ContactService.getContactPhotoStream"
200
+ }
201
+ },
202
+ "delete" : {
203
+ "tags" : [ "Contact" ],
204
+ "summary" : "Delete contact photo",
205
+ "description" : "This API deletes the display picture of a contact.",
206
+ "operationId" : "deleteContactPhoto",
207
+ "parameters" : [ {
208
+ "$ref" : "#/components/parameters/contactId"
209
+ }, {
210
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
211
+ } ],
212
+ "responses" : {
213
+ "422" : {
214
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
215
+ },
216
+ "204" : {
217
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
218
+ },
219
+ "403" : {
220
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
221
+ }
222
+ },
223
+ "security" : [ {
224
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
225
+ }, {
226
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
227
+ } ],
228
+ "x-audience" : [ "external-public" ],
229
+ "x-custom-url-attribute" : {
230
+ "security" : {
231
+ "throttle" : {
232
+ "policy" : "WriteAPI_Stringent_UserPolicy"
233
+ },
234
+ "extraparams" : {
235
+ "disable" : true,
236
+ "ignore" : false
237
+ },
238
+ "authentication" : { }
239
+ },
240
+ "clan-group" : "contacts",
241
+ "apihash" : "094e8186745d232304aa10b2ccc711eb",
242
+ "module-group" : "contacts",
243
+ "apimethod" : "com.zoho.support.restapi.ContactService.deleteContactPhoto"
244
+ }
245
+ }
246
+ },
247
+ "/api/v1/contacts/{contactId}/statistics" : {
248
+ "get" : {
249
+ "tags" : [ "Contact" ],
250
+ "summary" : "Get contact statistics",
251
+ "description" : "This API fetches the overall statistics of an contact.",
252
+ "operationId" : "getContactStatistics",
253
+ "parameters" : [ {
254
+ "name" : "department",
255
+ "in" : "query",
256
+ "description" : "_This Param is being deprecated please use the departmentId param to fetch the department specific statistics_",
257
+ "required" : false,
258
+ "style" : "form",
259
+ "explode" : true,
260
+ "schema" : {
261
+ "type" : [ "string", "null", "integer" ],
262
+ "format" : "int64",
263
+ "description" : "_This Param is being deprecated please use the departmentId param to fetch the department specific statistics_",
264
+ "pattern" : "([0-9]+)",
265
+ "x-custom-parameters-attributes" : {
266
+ "entity" : "Departments"
267
+ },
268
+ "x-audience" : [ "company-internal" ]
269
+ }
270
+ }, {
271
+ "name" : "timeRange",
272
+ "in" : "query",
273
+ "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.",
274
+ "required" : false,
275
+ "style" : "form",
276
+ "explode" : true,
277
+ "schema" : {
278
+ "type" : [ "string", "null" ],
279
+ "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.",
280
+ "maxLength" : 100,
281
+ "minLength" : 0,
282
+ "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",
283
+ "x-audience" : [ "company-internal" ]
284
+ }
285
+ }, {
286
+ "$ref" : "#/components/parameters/contactId"
287
+ }, {
288
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
289
+ } ],
290
+ "responses" : {
291
+ "200" : {
292
+ "$ref" : "#/components/responses/getStatistics"
293
+ }
294
+ },
295
+ "security" : [ {
296
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
297
+ }, {
298
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
299
+ } ],
300
+ "x-audience" : [ "external-public" ],
301
+ "x-custom-url-attribute" : {
302
+ "security" : {
303
+ "throttle" : {
304
+ "policy" : "ReadAPI_Standard_UserPolicy"
305
+ },
306
+ "extraparams" : {
307
+ "disable" : true,
308
+ "ignore" : false
309
+ },
310
+ "authentication" : { }
311
+ },
312
+ "clan-group" : "contacts",
313
+ "apihash" : "71ff0aae16517373e849ab17c0221b95",
314
+ "module-group" : "contacts",
315
+ "apimethod" : "com.zoho.support.restapi.ContactService.getStatistics"
316
+ }
317
+ }
318
+ },
319
+ "/api/v1/contacts/{contactId}/dissociateAccounts" : {
320
+ "post" : {
321
+ "tags" : [ "Contact" ],
322
+ "summary" : "Dissociate accounts from contact",
323
+ "description" : "This API dissociates multiple accounts from a particular contact.",
324
+ "operationId" : "dissociateAccountsWithContact",
325
+ "parameters" : [ {
326
+ "$ref" : "#/components/parameters/contactId"
327
+ }, {
328
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
329
+ } ],
330
+ "requestBody" : {
331
+ "$ref" : "#/components/requestBodies/dissociateAccountsWithContact"
332
+ },
333
+ "responses" : {
334
+ "422" : {
335
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
336
+ },
337
+ "200" : {
338
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
339
+ }
340
+ },
341
+ "security" : [ {
342
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
343
+ }, {
344
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
345
+ } ],
346
+ "x-audience" : [ "external-public" ],
347
+ "x-custom-url-attribute" : {
348
+ "security" : {
349
+ "throttle" : {
350
+ "inline" : [ {
351
+ "scope" : "APPSERVER",
352
+ "rules" : [ {
353
+ "duration" : 60000,
354
+ "lock-period" : 300000,
355
+ "threshold" : 50,
356
+ "hip" : false
357
+ }, {
358
+ "duration" : 3600000,
359
+ "lock-period" : 600000,
360
+ "threshold" : 300,
361
+ "hip" : false
362
+ } ],
363
+ "window" : "ROLLING",
364
+ "key" : "url.path+user.zuid"
365
+ } ]
366
+ },
367
+ "extraparams" : {
368
+ "disable" : true,
369
+ "ignore" : false
370
+ },
371
+ "authentication" : { }
372
+ },
373
+ "clan-group" : "contacts",
374
+ "apihash" : "77a84c05948c436686d0ccc6fd0d2b9c",
375
+ "module-group" : "contacts",
376
+ "apimethod" : "com.zoho.support.restapi.ContactService.dissociateAccountsWithContact"
377
+ }
378
+ }
379
+ },
380
+ "/api/v1/contacts/moveToTrash" : {
381
+ "post" : {
382
+ "tags" : [ "Contact" ],
383
+ "summary" : "Delete Contacts",
384
+ "description" : "This API moves the contacts specified to the Recycle Bin.",
385
+ "operationId" : "deleteContact",
386
+ "parameters" : [ {
387
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
388
+ } ],
389
+ "requestBody" : {
390
+ "$ref" : "#/components/requestBodies/deleteContactsRequest"
391
+ },
392
+ "responses" : {
393
+ "404" : {
394
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
395
+ },
396
+ "422" : {
397
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
398
+ },
399
+ "500" : {
400
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
401
+ },
402
+ "204" : {
403
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
404
+ },
405
+ "403" : {
406
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
407
+ }
408
+ },
409
+ "security" : [ {
410
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
411
+ }, {
412
+ "iam-oauth2-schema" : [ "Desk.contacts.DELETE" ]
413
+ } ],
414
+ "x-audience" : [ "external-public" ],
415
+ "x-custom-url-attribute" : {
416
+ "security" : {
417
+ "throttle" : {
418
+ "inline" : [ {
419
+ "scope" : "APPSERVER",
420
+ "rules" : [ {
421
+ "duration" : 60000,
422
+ "lock-period" : 600000,
423
+ "threshold" : 30,
424
+ "hip" : false
425
+ } ],
426
+ "window" : "ROLLING",
427
+ "key" : "url.path+user.zuid"
428
+ } ]
429
+ },
430
+ "extraparams" : {
431
+ "disable" : true,
432
+ "ignore" : false
433
+ },
434
+ "authentication" : { }
435
+ },
436
+ "clan-group" : "contacts",
437
+ "apihash" : "dbddb0beb82ec1a895c65cc140caa374",
438
+ "module-group" : "contacts",
439
+ "apimethod" : "com.zoho.support.restapi.ContactService.moveContactsToTrash"
440
+ }
441
+ }
442
+ },
443
+ "/api/v1/contacts/{contactId}/accounts/{accountId}/dissociate" : {
444
+ "patch" : {
445
+ "tags" : [ "Contact" ],
446
+ "summary" : "Dissociate account from contact",
447
+ "description" : "This API dissociates a particular account from a contact.",
448
+ "operationId" : "dissociateAccountWithContact",
449
+ "parameters" : [ {
450
+ "$ref" : "#/components/parameters/accountId"
451
+ }, {
452
+ "$ref" : "#/components/parameters/contactId"
453
+ }, {
454
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
455
+ } ],
456
+ "responses" : {
457
+ "422" : {
458
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
459
+ },
460
+ "204" : {
461
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
462
+ },
463
+ "403" : {
464
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
465
+ }
466
+ },
467
+ "security" : [ {
468
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
469
+ }, {
470
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
471
+ } ],
472
+ "x-audience" : [ "external-public" ],
473
+ "x-custom-url-attribute" : {
474
+ "security" : {
475
+ "throttle" : {
476
+ "policy" : "WriteAPI_Standard_UserPolicy"
477
+ },
478
+ "extraparams" : {
479
+ "disable" : true,
480
+ "ignore" : false
481
+ },
482
+ "authentication" : { }
483
+ },
484
+ "clan-group" : "contacts",
485
+ "apihash" : "2d910fcf73029a0159851d08e593e6e6",
486
+ "module-group" : "contacts",
487
+ "apimethod" : "com.zoho.support.restapi.ContactService.dissociateAccountFromContact"
488
+ }
489
+ }
490
+ },
491
+ "/api/v1/contacts/{contactId}/helpCenters" : {
492
+ "get" : {
493
+ "tags" : [ "Contact" ],
494
+ "summary" : "Get status of contact in help centers",
495
+ "description" : "This API fetches a particular contact's activation status in all the help centers they are part of.",
496
+ "operationId" : "getContactActivationStatusAcrossHelpCenters",
497
+ "parameters" : [ {
498
+ "$ref" : "#/components/parameters/contactId"
499
+ }, {
500
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
501
+ } ],
502
+ "responses" : {
503
+ "422" : {
504
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
505
+ },
506
+ "200" : {
507
+ "$ref" : "./ResponseHelpCenterUser.json#/components/responses/listHelpCenters"
508
+ },
509
+ "403" : {
510
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
511
+ }
512
+ },
513
+ "security" : [ {
514
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
515
+ }, {
516
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
517
+ } ],
518
+ "x-audience" : [ "external-public" ],
519
+ "x-custom-url-attribute" : {
520
+ "security" : {
521
+ "throttle" : {
522
+ "policy" : "ReadAPI_Standard_UserPolicy"
523
+ },
524
+ "extraparams" : {
525
+ "disable" : true,
526
+ "ignore" : false
527
+ },
528
+ "authentication" : { }
529
+ },
530
+ "clan-group" : "contacts",
531
+ "apihash" : "747670b67c9f8f15873f54270b0ceec2",
532
+ "module-group" : "contacts",
533
+ "apimethod" : "com.zoho.support.restapi.ContactService.getHelpCenteDetails"
534
+ }
535
+ }
536
+ },
537
+ "/api/v1/contacts/{contactId}/history" : {
538
+ "get" : {
539
+ "tags" : [ "Contact" ],
540
+ "summary" : "Get contact history",
541
+ "description" : "This API fetches the ticket history of a contact.",
542
+ "operationId" : "getContactTicketHistory",
543
+ "parameters" : [ {
544
+ "name" : "agentId",
545
+ "in" : "query",
546
+ "description" : " Key that filters ticket activities performed by a particular agent",
547
+ "required" : false,
548
+ "style" : "form",
549
+ "explode" : true,
550
+ "schema" : {
551
+ "type" : [ "string", "null", "integer" ],
552
+ "format" : "int64",
553
+ "description" : " Key that filters ticket activities performed by a particular agent",
554
+ "pattern" : "([0-9]+)"
555
+ }
556
+ }, {
557
+ "name" : "departmentId",
558
+ "in" : "query",
559
+ "description" : " ID of the department from which the history details must be fetched",
560
+ "required" : false,
561
+ "style" : "form",
562
+ "explode" : true,
563
+ "schema" : {
564
+ "type" : [ "string", "null", "integer" ],
565
+ "format" : "int64",
566
+ "description" : " ID of the department from which the history details must be fetched",
567
+ "pattern" : "([0-9]+)"
568
+ }
569
+ }, {
570
+ "$ref" : "#/components/parameters/limit"
571
+ }, {
572
+ "$ref" : "#/components/parameters/from"
573
+ }, {
574
+ "$ref" : "#/components/parameters/contactId"
575
+ }, {
576
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
577
+ } ],
578
+ "responses" : {
579
+ "404" : {
580
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
581
+ },
582
+ "200" : {
583
+ "$ref" : "./TicketHistory.json#/components/responses/accountContactHistoryResponse"
584
+ },
585
+ "422" : {
586
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
587
+ },
588
+ "401" : {
589
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
590
+ }
591
+ },
592
+ "security" : [ {
593
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
594
+ }, {
595
+ "iam-oauth2-schema" : [ "Desk.contacts.READ", "Desk.tickets.READ" ]
596
+ } ],
597
+ "x-audience" : [ "external-public" ],
598
+ "x-custom-url-attribute" : {
599
+ "security" : {
600
+ "throttle" : {
601
+ "policy" : "ReadAPI_Standard_UserPolicy"
602
+ },
603
+ "extraparams" : {
604
+ "disable" : true,
605
+ "ignore" : false
606
+ },
607
+ "authentication" : { }
608
+ },
609
+ "clan-group" : "tickets",
610
+ "apihash" : "af7f248e76586f0ef88a983b01f6d93b",
611
+ "module-group" : "tickets",
612
+ "apimethod" : "com.zoho.support.restapi.HistoryService.getTicketsHistoryForContact"
613
+ }
614
+ }
615
+ },
616
+ "/api/v1/contacts" : {
617
+ "get" : {
618
+ "tags" : [ "Contact" ],
619
+ "summary" : "List Contacts",
620
+ "description" : "This API lists a particular number of contacts, based on the limit specified. ",
621
+ "operationId" : "getContacts",
622
+ "parameters" : [ {
623
+ "name" : "include",
624
+ "in" : "query",
625
+ "required" : false,
626
+ "style" : "simple",
627
+ "explode" : true,
628
+ "schema" : {
629
+ "type" : [ "null", "array" ],
630
+ "items" : {
631
+ "type" : [ "string", "null" ],
632
+ "enum" : [ "accounts" ],
633
+ "maxLength" : 100,
634
+ "minLength" : 0
635
+ },
636
+ "uniqueItems" : true
637
+ }
638
+ }, {
639
+ "$ref" : "#/components/parameters/viewId"
640
+ }, {
641
+ "$ref" : "#/components/parameters/limit"
642
+ }, {
643
+ "$ref" : "#/components/parameters/from"
644
+ }, {
645
+ "name" : "sortBy",
646
+ "in" : "query",
647
+ "required" : false,
648
+ "style" : "form",
649
+ "explode" : true,
650
+ "schema" : {
651
+ "type" : [ "string", "null" ],
652
+ "enum" : [ "firstName", "lastName", "phone", "email", "account", "createdTime", "modifiedTime" ],
653
+ "maxLength" : 100,
654
+ "minLength" : 0
655
+ }
656
+ }, {
657
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
658
+ } ],
659
+ "responses" : {
660
+ "200" : {
661
+ "$ref" : "#/components/responses/contactListViewArray"
662
+ },
663
+ "403" : {
664
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
665
+ }
666
+ },
667
+ "security" : [ {
668
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
669
+ }, {
670
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
671
+ } ],
672
+ "x-audience" : [ "external-public" ],
673
+ "x-custom-url-attribute" : {
674
+ "security" : {
675
+ "throttle" : {
676
+ "policy" : "ReadAPI_Standard_UserPolicy"
677
+ },
678
+ "extraparams" : {
679
+ "disable" : true,
680
+ "ignore" : false
681
+ },
682
+ "authentication" : { }
683
+ },
684
+ "clan-group" : "contacts",
685
+ "apihash" : "9942c5f38b55e3df0e22ce6d4b9eda1d",
686
+ "module-group" : "contacts",
687
+ "apimethod" : "com.zoho.support.restapi.ContactService.getContacts"
688
+ }
689
+ },
690
+ "post" : {
691
+ "tags" : [ "Contact" ],
692
+ "summary" : "Create Contact",
693
+ "description" : "This API creates a contact in your help desk portal.",
694
+ "operationId" : "createContact",
695
+ "parameters" : [ {
696
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
697
+ } ],
698
+ "requestBody" : {
699
+ "$ref" : "#/components/requestBodies/contactjson"
700
+ },
701
+ "responses" : {
702
+ "422" : {
703
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
704
+ },
705
+ "200" : {
706
+ "$ref" : "#/components/responses/contactResponse"
707
+ }
708
+ },
709
+ "security" : [ {
710
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
711
+ }, {
712
+ "iam-oauth2-schema" : [ "Desk.contacts.CREATE" ]
713
+ } ],
714
+ "x-audience" : [ "external-public" ],
715
+ "x-custom-url-attribute" : {
716
+ "security" : {
717
+ "throttle" : {
718
+ "policy" : "WriteAPI_Standard_UserPolicy"
719
+ },
720
+ "extraparams" : {
721
+ "disable" : true,
722
+ "ignore" : false
723
+ },
724
+ "authentication" : { }
725
+ },
726
+ "clan-group" : "contacts",
727
+ "apihash" : "83782143351bea84573aa1895586eb35",
728
+ "module-group" : "contacts",
729
+ "apimethod" : "com.zoho.support.restapi.ContactService.addContact"
730
+ }
731
+ }
732
+ },
733
+ "/api/v1/contacts/updateMany" : {
734
+ "post" : {
735
+ "tags" : [ "Contact" ],
736
+ "summary" : "Update many contacts",
737
+ "description" : "This API updates multiple contacts at once.",
738
+ "operationId" : "bulkUpdateContacts",
739
+ "parameters" : [ {
740
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
741
+ } ],
742
+ "requestBody" : {
743
+ "$ref" : "#/components/requestBodies/contact_massupdate"
744
+ },
745
+ "responses" : {
746
+ "404" : {
747
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
748
+ },
749
+ "200" : {
750
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
751
+ },
752
+ "422" : {
753
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
754
+ },
755
+ "401" : {
756
+ "$ref" : "../common/Common.json#/components/responses/unauthorizedErrorResponse"
757
+ }
758
+ },
759
+ "security" : [ {
760
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
761
+ }, {
762
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
763
+ } ],
764
+ "x-audience" : [ "external-public" ],
765
+ "x-custom-url-attribute" : {
766
+ "security" : {
767
+ "throttle" : {
768
+ "inline" : [ {
769
+ "scope" : "APPSERVER",
770
+ "rules" : [ {
771
+ "duration" : 60000,
772
+ "lock-period" : 300000,
773
+ "threshold" : 50,
774
+ "hip" : false
775
+ }, {
776
+ "duration" : 3600000,
777
+ "lock-period" : 900000,
778
+ "threshold" : 400,
779
+ "hip" : false
780
+ } ],
781
+ "window" : "ROLLING",
782
+ "key" : "url.path+user.zuid"
783
+ } ]
784
+ },
785
+ "extraparams" : {
786
+ "disable" : true,
787
+ "ignore" : false
788
+ },
789
+ "authentication" : { }
790
+ },
791
+ "clan-group" : "contacts",
792
+ "apihash" : "15f016bb7fd1b108689ae80551876c26",
793
+ "module-group" : "contacts",
794
+ "apimethod" : "com.zoho.support.restapi.ContactService.updateMany"
795
+ }
796
+ }
797
+ },
798
+ "/api/v1/contacts/count" : {
799
+ "get" : {
800
+ "tags" : [ "Contact" ],
801
+ "summary" : "Get contacts count",
802
+ "description" : "This API displays the count for the number of contacts in a custom view",
803
+ "operationId" : "getContactsCount",
804
+ "parameters" : [ {
805
+ "name" : "viewId",
806
+ "in" : "query",
807
+ "required" : true,
808
+ "style" : "form",
809
+ "explode" : true,
810
+ "schema" : {
811
+ "type" : [ "string", "null", "integer" ],
812
+ "format" : "int64",
813
+ "pattern" : "([0-9]+)"
814
+ }
815
+ }, {
816
+ "name" : "startsWith",
817
+ "in" : "query",
818
+ "required" : false,
819
+ "style" : "form",
820
+ "explode" : true,
821
+ "schema" : {
822
+ "type" : [ "string", "null" ],
823
+ "maxLength" : 100,
824
+ "minLength" : 0
825
+ }
826
+ }, {
827
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
828
+ } ],
829
+ "responses" : {
830
+ "422" : {
831
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
832
+ },
833
+ "200" : {
834
+ "$ref" : "#/components/responses/countJson"
835
+ }
836
+ },
837
+ "security" : [ {
838
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
839
+ }, {
840
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
841
+ } ],
842
+ "x-audience" : [ "external-public" ],
843
+ "x-custom-url-attribute" : {
844
+ "security" : {
845
+ "throttle" : {
846
+ "policy" : "ReadAPI_Standard_UserPolicy"
847
+ },
848
+ "extraparams" : {
849
+ "disable" : true,
850
+ "ignore" : false
851
+ },
852
+ "authentication" : { }
853
+ },
854
+ "clan-group" : "contacts",
855
+ "apihash" : "3731ea92ead1893772ebe127e70385ee",
856
+ "module-group" : "contacts",
857
+ "apimethod" : "com.zoho.support.restapi.RecordsCountService.getContactsCount"
858
+ }
859
+ }
860
+ },
861
+ "/api/v1/contacts/contactsByIds" : {
862
+ "get" : {
863
+ "tags" : [ "Contact" ],
864
+ "summary" : "List Contacts By Ids",
865
+ "description" : "This API lists details of specific contacts, based on the IDs passed in the request.",
866
+ "operationId" : "getContactsByIds",
867
+ "parameters" : [ {
868
+ "name" : "ids",
869
+ "in" : "query",
870
+ "description" : "List of Contact Ids (separated by comma) which must be fetched. The maximum number of IDs allowed is 20.",
871
+ "required" : true,
872
+ "style" : "simple",
873
+ "explode" : true,
874
+ "schema" : {
875
+ "type" : [ "null", "array" ],
876
+ "description" : "List of Contact Ids (separated by comma) which must be fetched. The maximum number of IDs allowed is 20.",
877
+ "items" : {
878
+ "type" : [ "string", "null", "integer" ],
879
+ "format" : "int64",
880
+ "pattern" : "([0-9]+)",
881
+ "x-custom-parameters-attributes" : [ false, false, false, "", false, "List of Contact Ids (separated by comma) which must be fetched. The maximum number of IDs allowed is 20.", false, 10, ",", false, false, "0,5", false, false ]
882
+ },
883
+ "uniqueItems" : false
884
+ }
885
+ }, {
886
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
887
+ } ],
888
+ "responses" : {
889
+ "422" : {
890
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
891
+ },
892
+ "200" : {
893
+ "$ref" : "#/components/responses/contactListViewArray"
894
+ }
895
+ },
896
+ "security" : [ {
897
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
898
+ }, {
899
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
900
+ } ],
901
+ "x-audience" : [ "external-public" ],
902
+ "x-custom-url-attribute" : {
903
+ "security" : {
904
+ "throttle" : {
905
+ "policy" : "ReadAPI_Stringent_UserPolicy"
906
+ },
907
+ "extraparams" : {
908
+ "disable" : true,
909
+ "ignore" : false
910
+ },
911
+ "authentication" : { }
912
+ },
913
+ "clan-group" : "contacts",
914
+ "apihash" : "7cd37ecd37038af9dd1f7320b9aabda7",
915
+ "module-group" : "contacts",
916
+ "apimethod" : "com.zoho.support.restapi.ContactService.getContactsByIds"
917
+ }
918
+ }
919
+ },
920
+ "/api/v1/contacts/{contactId}" : {
921
+ "get" : {
922
+ "tags" : [ "Contact" ],
923
+ "summary" : "Get Contact",
924
+ "description" : "This API fetches a single contact from your help desk portal.",
925
+ "operationId" : "getContact",
926
+ "parameters" : [ {
927
+ "name" : "include",
928
+ "in" : "query",
929
+ "description" : "Allowed values are : @accounts@ , @owner@",
930
+ "required" : false,
931
+ "style" : "simple",
932
+ "explode" : true,
933
+ "schema" : {
934
+ "type" : [ "null", "array" ],
935
+ "description" : "Allowed values are : @accounts@ , @owner@",
936
+ "items" : {
937
+ "type" : [ "string", "null" ],
938
+ "enum" : [ "accounts", "owner" ],
939
+ "maxLength" : 100,
940
+ "minLength" : 0,
941
+ "x-custom-parameters-attributes" : [ ]
942
+ },
943
+ "uniqueItems" : true
944
+ }
945
+ }, {
946
+ "$ref" : "#/components/parameters/contactId"
947
+ }, {
948
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
949
+ } ],
950
+ "responses" : {
951
+ "200" : {
952
+ "$ref" : "#/components/responses/contactResponse"
953
+ }
954
+ },
955
+ "security" : [ {
956
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
957
+ }, {
958
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
959
+ } ],
960
+ "x-audience" : [ "external-public" ],
961
+ "x-custom-url-attribute" : {
962
+ "security" : {
963
+ "throttle" : {
964
+ "policy" : "ReadAPI_Lenient_UserPolicy"
965
+ },
966
+ "extraparams" : {
967
+ "disable" : true,
968
+ "ignore" : false
969
+ },
970
+ "authentication" : { }
971
+ },
972
+ "clan-group" : "contacts",
973
+ "apihash" : "0854258fa18657a7d600216bbacc3098",
974
+ "module-group" : "contacts",
975
+ "apimethod" : "com.zoho.support.restapi.ContactService.getContact"
976
+ }
977
+ },
978
+ "patch" : {
979
+ "tags" : [ "Contact" ],
980
+ "operationId" : "updateContact",
981
+ "summary" : "Update Contact",
982
+ "description" : "This API updates details of an existing contact.",
983
+ "parameters" : [ {
984
+ "$ref" : "#/components/parameters/contactId"
985
+ }, {
986
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
987
+ } ],
988
+ "requestBody" : {
989
+ "$ref" : "#/components/requestBodies/updateContact_contactjson"
990
+ },
991
+ "responses" : {
992
+ "422" : {
993
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
994
+ },
995
+ "200" : {
996
+ "$ref" : "#/components/responses/contactResponse"
997
+ }
998
+ },
999
+ "security" : [ {
1000
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1001
+ }, {
1002
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1003
+ } ],
1004
+ "x-audience" : [ "external-public" ],
1005
+ "x-custom-url-attribute" : {
1006
+ "security" : {
1007
+ "throttle" : {
1008
+ "policy" : "WriteAPI_Lenient_UserPolicy"
1009
+ },
1010
+ "extraparams" : {
1011
+ "disable" : true,
1012
+ "ignore" : false
1013
+ },
1014
+ "authentication" : { }
1015
+ },
1016
+ "clan-group" : "contacts",
1017
+ "apihash" : "9f361ecdabdfe005b2826fd1503a086e",
1018
+ "module-group" : "contacts",
1019
+ "apimethod" : "com.zoho.support.restapi.ContactService.updateContact"
1020
+ }
1021
+ }
1022
+ },
1023
+ "/api/v1/contacts/{contactId}/merge" : {
1024
+ "post" : {
1025
+ "tags" : [ "Contact" ],
1026
+ "summary" : "Merge Contacts",
1027
+ "description" : "This API merges two or more contacts <br/></br/>_Note:_<br/>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.",
1028
+ "operationId" : "mergeContacts",
1029
+ "parameters" : [ {
1030
+ "$ref" : "#/components/parameters/contactId"
1031
+ }, {
1032
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1033
+ } ],
1034
+ "requestBody" : {
1035
+ "$ref" : "#/components/requestBodies/contactMergeRequest"
1036
+ },
1037
+ "responses" : {
1038
+ "404" : {
1039
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
1040
+ },
1041
+ "200" : {
1042
+ "$ref" : "#/components/responses/contactResponse"
1043
+ },
1044
+ "422" : {
1045
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1046
+ },
1047
+ "500" : {
1048
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1049
+ },
1050
+ "403" : {
1051
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1052
+ }
1053
+ },
1054
+ "security" : [ {
1055
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1056
+ }, {
1057
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1058
+ } ],
1059
+ "x-audience" : [ "external-public" ],
1060
+ "x-custom-url-attribute" : {
1061
+ "security" : {
1062
+ "throttle" : {
1063
+ "inline" : [ {
1064
+ "scope" : "APPSERVER",
1065
+ "rules" : [ {
1066
+ "duration" : 60000,
1067
+ "lock-period" : 300000,
1068
+ "threshold" : 20,
1069
+ "hip" : false
1070
+ }, {
1071
+ "duration" : 3600000,
1072
+ "lock-period" : 600000,
1073
+ "threshold" : 100,
1074
+ "hip" : false
1075
+ } ],
1076
+ "window" : "ROLLING",
1077
+ "key" : "url.path+user.zuid"
1078
+ } ]
1079
+ },
1080
+ "extraparams" : {
1081
+ "disable" : true,
1082
+ "ignore" : false
1083
+ },
1084
+ "authentication" : { }
1085
+ },
1086
+ "clan-group" : "contacts",
1087
+ "apihash" : "69942297f71907a1b9a948d5fab987e8",
1088
+ "module-group" : "contacts",
1089
+ "apimethod" : "com.zoho.support.restapi.ContactService.merge"
1090
+ }
1091
+ }
1092
+ },
1093
+ "/api/v1/contacts/{contactId}/approveEndUserInvite" : {
1094
+ "post" : {
1095
+ "tags" : [ "Contact" ],
1096
+ "summary" : "Approve contact for help center",
1097
+ "description" : "This API helps approve a particular contact as an end-user to your help center.",
1098
+ "operationId" : "approveEndUserInvite",
1099
+ "parameters" : [ {
1100
+ "$ref" : "#/components/parameters/contactId"
1101
+ }, {
1102
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1103
+ } ],
1104
+ "requestBody" : {
1105
+ "$ref" : "#/components/requestBodies/updateSignupApproval"
1106
+ },
1107
+ "responses" : {
1108
+ "404" : {
1109
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
1110
+ },
1111
+ "200" : {
1112
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
1113
+ },
1114
+ "422" : {
1115
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1116
+ },
1117
+ "500" : {
1118
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1119
+ },
1120
+ "403" : {
1121
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1122
+ }
1123
+ },
1124
+ "security" : [ {
1125
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1126
+ }, {
1127
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1128
+ } ],
1129
+ "x-audience" : [ "external-public" ],
1130
+ "x-custom-url-attribute" : {
1131
+ "security" : {
1132
+ "throttle" : {
1133
+ "policy" : "WriteAPI_Standard_UserPolicy"
1134
+ },
1135
+ "extraparams" : {
1136
+ "disable" : true,
1137
+ "ignore" : false
1138
+ },
1139
+ "authentication" : { }
1140
+ },
1141
+ "clan-group" : "contacts",
1142
+ "apihash" : "29f946387e3a569313fa2116403d9a07",
1143
+ "module-group" : "contacts",
1144
+ "apimethod" : "com.zoho.support.restapi.ContactService.approveEndUserInvite"
1145
+ }
1146
+ }
1147
+ },
1148
+ "/api/v1/contacts/{contactId}/rejectEndUserInvite" : {
1149
+ "post" : {
1150
+ "tags" : [ "Contact" ],
1151
+ "summary" : "Reject contact for help center",
1152
+ "description" : "This API helps reject a particular contact from being added as an end-user to your help center.",
1153
+ "operationId" : "rejectEndUserInvite",
1154
+ "parameters" : [ {
1155
+ "$ref" : "#/components/parameters/contactId"
1156
+ }, {
1157
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1158
+ } ],
1159
+ "requestBody" : {
1160
+ "$ref" : "#/components/requestBodies/rejectEndUserInvite_updateSignupApproval"
1161
+ },
1162
+ "responses" : {
1163
+ "404" : {
1164
+ "$ref" : "../common/Common.json#/components/responses/urlNotFoundErrorResponse"
1165
+ },
1166
+ "200" : {
1167
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
1168
+ },
1169
+ "422" : {
1170
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1171
+ },
1172
+ "500" : {
1173
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1174
+ },
1175
+ "403" : {
1176
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1177
+ }
1178
+ },
1179
+ "security" : [ {
1180
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1181
+ }, {
1182
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1183
+ } ],
1184
+ "x-audience" : [ "external-public" ],
1185
+ "x-custom-url-attribute" : {
1186
+ "security" : {
1187
+ "throttle" : {
1188
+ "policy" : "WriteAPI_Standard_UserPolicy"
1189
+ },
1190
+ "extraparams" : {
1191
+ "disable" : true,
1192
+ "ignore" : false
1193
+ },
1194
+ "authentication" : { }
1195
+ },
1196
+ "clan-group" : "contacts",
1197
+ "apihash" : "ad1ed33639f37d6d072e47aefb14ac89",
1198
+ "module-group" : "contacts",
1199
+ "apimethod" : "com.zoho.support.restapi.ContactService.rejectEndUserInvite"
1200
+ }
1201
+ }
1202
+ },
1203
+ "/api/v1/contacts/{contactId}/associateAccounts" : {
1204
+ "post" : {
1205
+ "tags" : [ "Contact" ],
1206
+ "summary" : "Associate accounts with contact",
1207
+ "description" : "This API associates multiple accounts with a particular contact.",
1208
+ "operationId" : "associateAccountsWithContact",
1209
+ "parameters" : [ {
1210
+ "$ref" : "#/components/parameters/contactId"
1211
+ }, {
1212
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1213
+ } ],
1214
+ "requestBody" : {
1215
+ "$ref" : "#/components/requestBodies/associateAccountsWithContact"
1216
+ },
1217
+ "responses" : {
1218
+ "422" : {
1219
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1220
+ },
1221
+ "200" : {
1222
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
1223
+ }
1224
+ },
1225
+ "security" : [ {
1226
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1227
+ }, {
1228
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1229
+ } ],
1230
+ "x-audience" : [ "external-public" ],
1231
+ "x-custom-url-attribute" : {
1232
+ "security" : {
1233
+ "throttle" : {
1234
+ "inline" : [ {
1235
+ "scope" : "APPSERVER",
1236
+ "rules" : [ {
1237
+ "duration" : 60000,
1238
+ "lock-period" : 300000,
1239
+ "threshold" : 50,
1240
+ "hip" : false
1241
+ }, {
1242
+ "duration" : 3600000,
1243
+ "lock-period" : 600000,
1244
+ "threshold" : 300,
1245
+ "hip" : false
1246
+ } ],
1247
+ "window" : "ROLLING",
1248
+ "key" : "url.path+user.zuid"
1249
+ } ]
1250
+ },
1251
+ "extraparams" : {
1252
+ "disable" : true,
1253
+ "ignore" : false
1254
+ },
1255
+ "authentication" : { }
1256
+ },
1257
+ "clan-group" : "contacts",
1258
+ "apihash" : "423e3ed4330e2c3cea126d16fea82186",
1259
+ "module-group" : "contacts",
1260
+ "apimethod" : "com.zoho.support.restapi.ContactService.associateAccountsWithContact"
1261
+ }
1262
+ }
1263
+ },
1264
+ "/api/v1/contacts/{contactId}/associateProducts" : {
1265
+ "post" : {
1266
+ "tags" : [ "Contact" ],
1267
+ "summary" : "Associate products with a contact",
1268
+ "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.",
1269
+ "operationId" : "associateProductsWithContact",
1270
+ "parameters" : [ {
1271
+ "$ref" : "#/components/parameters/contactId"
1272
+ }, {
1273
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1274
+ } ],
1275
+ "requestBody" : {
1276
+ "$ref" : "#/components/requestBodies/associateProductsWithContact"
1277
+ },
1278
+ "responses" : {
1279
+ "422" : {
1280
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1281
+ },
1282
+ "200" : {
1283
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
1284
+ }
1285
+ },
1286
+ "security" : [ {
1287
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1288
+ }, {
1289
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1290
+ } ],
1291
+ "x-audience" : [ "external-public" ],
1292
+ "x-custom-url-attribute" : {
1293
+ "security" : {
1294
+ "throttle" : {
1295
+ "inline" : [ {
1296
+ "scope" : "APPSERVER",
1297
+ "rules" : [ {
1298
+ "duration" : 60000,
1299
+ "lock-period" : 600000,
1300
+ "threshold" : 30,
1301
+ "hip" : false
1302
+ }, {
1303
+ "duration" : 3600000,
1304
+ "lock-period" : 1800000,
1305
+ "threshold" : 120,
1306
+ "hip" : false
1307
+ } ],
1308
+ "window" : "ROLLING",
1309
+ "key" : "url.path+user.zuid"
1310
+ } ]
1311
+ },
1312
+ "extraparams" : {
1313
+ "disable" : true,
1314
+ "ignore" : false
1315
+ },
1316
+ "authentication" : { }
1317
+ },
1318
+ "clan-group" : "contacts",
1319
+ "apihash" : "38cdf5176c2a76bb730d7d6e2cf49246",
1320
+ "module-group" : "contacts",
1321
+ "apimethod" : "com.zoho.support.restapi.ContactService.associateProductsWithContact"
1322
+ }
1323
+ }
1324
+ },
1325
+ "/api/v1/contacts/markSpam" : {
1326
+ "post" : {
1327
+ "tags" : [ "Contact" ],
1328
+ "summary" : "Mark contact as spam",
1329
+ "description" : "This API marks contacts as spam.",
1330
+ "operationId" : "markContactsAsSpam",
1331
+ "requestBody" : {
1332
+ "$ref" : "#/components/requestBodies/markSpamContactPayload"
1333
+ },
1334
+ "responses" : {
1335
+ "422" : {
1336
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1337
+ },
1338
+ "200" : {
1339
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
1340
+ }
1341
+ },
1342
+ "security" : [ {
1343
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1344
+ }, {
1345
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1346
+ } ],
1347
+ "x-audience" : [ "external-public" ]
1348
+ }
1349
+ },
1350
+ "/api/v1/contacts/deleteSpam" : {
1351
+ "post" : {
1352
+ "tags" : [ "Contact" ],
1353
+ "summary" : "Delete spam contacts",
1354
+ "description" : "This API deletes the given spam contacts",
1355
+ "operationId" : "deleteSpamContacts",
1356
+ "parameters" : [ {
1357
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1358
+ } ],
1359
+ "requestBody" : {
1360
+ "$ref" : "#/components/requestBodies/deleteSpamContacts_deleteContactsRequest"
1361
+ },
1362
+ "responses" : {
1363
+ "422" : {
1364
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1365
+ },
1366
+ "200" : {
1367
+ "$ref" : "./MassActionResponse.json#/components/responses/massActionListResponse"
1368
+ }
1369
+ },
1370
+ "security" : [ {
1371
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1372
+ }, {
1373
+ "iam-oauth2-schema" : [ "Desk.contacts.DELETE" ]
1374
+ } ],
1375
+ "x-audience" : [ "external-public" ],
1376
+ "x-custom-url-attribute" : {
1377
+ "security" : {
1378
+ "throttle" : {
1379
+ "policy" : "WriteAPI_Standard_UserPolicy"
1380
+ },
1381
+ "extraparams" : {
1382
+ "disable" : true,
1383
+ "ignore" : false
1384
+ },
1385
+ "authentication" : { }
1386
+ },
1387
+ "clan-group" : "contacts",
1388
+ "apihash" : "ad9491f13fb3c2d841e3a353571efc1a",
1389
+ "module-group" : "contacts",
1390
+ "apimethod" : "com.zoho.support.restapi.ContactService.deleteSpamContacts"
1391
+ }
1392
+ }
1393
+ },
1394
+ "/api/v1/contacts/{contactId}/inviteAsEndUser" : {
1395
+ "post" : {
1396
+ "tags" : [ "Contact" ],
1397
+ "summary" : "Invite contact to help center",
1398
+ "description" : "This API helps invite a particular contact as an end-user to your help center.",
1399
+ "operationId" : "inviteContactAsEndUser",
1400
+ "parameters" : [ {
1401
+ "$ref" : "#/components/parameters/contactId"
1402
+ }, {
1403
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1404
+ } ],
1405
+ "requestBody" : {
1406
+ "$ref" : "#/components/requestBodies/inviteContactAsEndUser"
1407
+ },
1408
+ "responses" : {
1409
+ "422" : {
1410
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1411
+ },
1412
+ "204" : {
1413
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1414
+ },
1415
+ "403" : {
1416
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1417
+ }
1418
+ },
1419
+ "security" : [ {
1420
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1421
+ }, {
1422
+ "iam-oauth2-schema" : [ "Desk.contacts.UPDATE" ]
1423
+ } ],
1424
+ "x-audience" : [ "external-public" ],
1425
+ "x-custom-url-attribute" : {
1426
+ "security" : {
1427
+ "throttle" : {
1428
+ "policy" : "WriteAPI_Standard_UserPolicy,InviteUSer_FreeAndTrialEditions_Policy"
1429
+ },
1430
+ "extraparams" : {
1431
+ "disable" : true,
1432
+ "ignore" : false
1433
+ },
1434
+ "authentication" : { }
1435
+ },
1436
+ "clan-group" : "contacts",
1437
+ "apihash" : "86f431066465c525de7ae17e5b4e6ae2",
1438
+ "module-group" : "contacts",
1439
+ "apimethod" : "com.zoho.support.restapi.ContactService.inviteContactAsEndUser"
1440
+ }
1441
+ }
1442
+ },
1443
+ "/api/v1/accounts/{accountId}/contacts" : {
1444
+ "get" : {
1445
+ "tags" : [ "Contact" ],
1446
+ "summary" : "List Associated contacts",
1447
+ "description" : "This API lists the contacts associated with an account",
1448
+ "operationId" : "getContactsUnderAccount",
1449
+ "parameters" : [ {
1450
+ "$ref" : "#/components/parameters/limit"
1451
+ }, {
1452
+ "$ref" : "#/components/parameters/from"
1453
+ }, {
1454
+ "name" : "sortBy",
1455
+ "in" : "query",
1456
+ "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@fullName,@! !@phone,@! !@email,@! !@createdTime,@! !@modifiedTime@!",
1457
+ "required" : false,
1458
+ "style" : "form",
1459
+ "explode" : true,
1460
+ "schema" : {
1461
+ "type" : [ "string", "null" ],
1462
+ "description" : "Parameter that sorts contacts by one of these attributes: !@firstName,@! !@lastName,@! !@fullName,@! !@phone,@! !@email,@! !@createdTime,@! !@modifiedTime@!",
1463
+ "enum" : [ "firstName", "lastName", "phone", "fullName", "email", "createdTime", "modifiedTime" ],
1464
+ "maxLength" : 100,
1465
+ "minLength" : 0
1466
+ }
1467
+ }, {
1468
+ "$ref" : "#/components/parameters/isSpam"
1469
+ }, {
1470
+ "$ref" : "#/components/parameters/accountId"
1471
+ }, {
1472
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1473
+ } ],
1474
+ "responses" : {
1475
+ "204" : {
1476
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1477
+ },
1478
+ "200" : {
1479
+ "$ref" : "#/components/responses/contactListViewArrayWithMappingInfo"
1480
+ }
1481
+ },
1482
+ "security" : [ {
1483
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1484
+ }, {
1485
+ "iam-oauth2-schema" : [ "Desk.contacts.READ" ]
1486
+ } ],
1487
+ "x-audience" : [ "external-public" ],
1488
+ "x-custom-url-attribute" : {
1489
+ "security" : {
1490
+ "throttle" : {
1491
+ "policy" : "ReadAPI_Standard_UserPolicy"
1492
+ },
1493
+ "extraparams" : {
1494
+ "disable" : true,
1495
+ "ignore" : false
1496
+ },
1497
+ "authentication" : { }
1498
+ },
1499
+ "clan-group" : "accounts",
1500
+ "apihash" : "3b3d07a9eedef5a04aa3017458295cfc",
1501
+ "module-group" : "accounts",
1502
+ "apimethod" : "com.zoho.support.restapi.AccountService.getAssociatedContactsForAccount"
1503
+ }
1504
+ }
1505
+ },
1506
+ "/api/v1/contacts/addMany" : {
1507
+ "post" : {
1508
+ "tags" : [ "Contact" ],
1509
+ "summary" : "Add Many contacts",
1510
+ "description" : "This API simultaneously adds multiple contacts to your help desk portal.",
1511
+ "operationId" : "addAndInviteAsPortalUser",
1512
+ "parameters" : [ {
1513
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1514
+ } ],
1515
+ "requestBody" : {
1516
+ "$ref" : "#/components/requestBodies/invitePortalUserJson"
1517
+ },
1518
+ "responses" : {
1519
+ "422" : {
1520
+ "$ref" : "../common/Common.json#/components/responses/invalidDataErrorResponse"
1521
+ },
1522
+ "200" : {
1523
+ "$ref" : "#/components/responses/contactListViewArray"
1524
+ }
1525
+ },
1526
+ "security" : [ {
1527
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1528
+ }, {
1529
+ "iam-oauth2-schema" : [ "Desk.contacts.CREATE" ]
1530
+ } ],
1531
+ "x-audience" : [ "company-internal" ],
1532
+ "x-custom-url-attribute" : {
1533
+ "security" : {
1534
+ "throttle" : {
1535
+ "inline" : [ {
1536
+ "scope" : "APPSERVER",
1537
+ "rules" : [ {
1538
+ "duration" : 60000,
1539
+ "lock-period" : 600000,
1540
+ "threshold" : 50,
1541
+ "hip" : false
1542
+ }, {
1543
+ "duration" : 3600000,
1544
+ "lock-period" : 1800000,
1545
+ "threshold" : 300,
1546
+ "hip" : false
1547
+ } ],
1548
+ "window" : "ROLLING",
1549
+ "key" : "url.path+user.zuid"
1550
+ } ]
1551
+ },
1552
+ "extraparams" : {
1553
+ "disable" : true,
1554
+ "ignore" : false
1555
+ },
1556
+ "authentication" : { }
1557
+ },
1558
+ "clan-group" : "contacts",
1559
+ "apihash" : "7c51489d4a96ea2f9f343d780320cd7e",
1560
+ "module-group" : "contacts",
1561
+ "apimethod" : "com.zoho.support.restapi.ContactService.addAndInviteAsPortalUser"
1562
+ }
1563
+ }
1564
+ }
1565
+ },
1566
+ "components" : {
1567
+ "schemas" : {
1568
+ "customerHappiness" : {
1569
+ "type" : [ "null", "object" ],
1570
+ "additionalProperties" : false,
1571
+ "properties" : {
1572
+ "badPercentage" : {
1573
+ "type" : [ "string", "null", "integer" ],
1574
+ "format" : "int32",
1575
+ "pattern" : "([0-9]+)"
1576
+ },
1577
+ "okPercentage" : {
1578
+ "type" : [ "string", "null", "integer" ],
1579
+ "format" : "int32",
1580
+ "pattern" : "([0-9]+)"
1581
+ },
1582
+ "goodPercentage" : {
1583
+ "type" : [ "string", "null", "integer" ],
1584
+ "format" : "int32",
1585
+ "pattern" : "([0-9]+)"
1586
+ }
1587
+ },
1588
+ "required" : [ "badPercentage", "goodPercentage", "okPercentage" ]
1589
+ },
1590
+ "zohoCRMContact" : {
1591
+ "type" : [ "null", "object" ],
1592
+ "additionalProperties" : false,
1593
+ "properties" : {
1594
+ "id" : {
1595
+ "type" : [ "string", "null", "integer" ],
1596
+ "format" : "int64",
1597
+ "pattern" : "([0-9]+)"
1598
+ },
1599
+ "type" : {
1600
+ "type" : [ "string", "null" ],
1601
+ "enum" : [ "new", "potentials", "customers", "contacts", "leads" ],
1602
+ "maxLength" : 100,
1603
+ "minLength" : 0
1604
+ }
1605
+ },
1606
+ "required" : [ "id", "type" ]
1607
+ },
1608
+ "commonJson" : {
1609
+ "type" : [ "null", "object" ],
1610
+ "additionalProperties" : false,
1611
+ "properties" : {
1612
+ "lastName" : {
1613
+ "type" : [ "string", "null" ],
1614
+ "description" : "Last name of the contact",
1615
+ "maxLength" : 200,
1616
+ "minLength" : 0
1617
+ },
1618
+ "accountId" : {
1619
+ "type" : [ "string", "null", "integer" ],
1620
+ "format" : "int64",
1621
+ "description" : "Account to which the contact is mapped",
1622
+ "pattern" : "([0-9]+)"
1623
+ },
1624
+ "firstName" : {
1625
+ "type" : [ "string", "null" ],
1626
+ "description" : "First name of the contact",
1627
+ "maxLength" : 40,
1628
+ "minLength" : 0
1629
+ },
1630
+ "secondaryEmail" : {
1631
+ "type" : [ "string", "null" ],
1632
+ "description" : "Secondary email ID of the contact",
1633
+ "maxLength" : 100,
1634
+ "minLength" : 0,
1635
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1636
+ },
1637
+ "phone" : {
1638
+ "type" : [ "string", "null" ],
1639
+ "description" : "Phone number of the contact",
1640
+ "maxLength" : 50,
1641
+ "minLength" : 0,
1642
+ "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1643
+ },
1644
+ "mobile" : {
1645
+ "type" : [ "string", "null" ],
1646
+ "description" : "Mobile number of the contact",
1647
+ "maxLength" : 50,
1648
+ "minLength" : 0,
1649
+ "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+"
1650
+ },
1651
+ "ownerId" : {
1652
+ "type" : [ "string", "null", "integer" ],
1653
+ "format" : "int64",
1654
+ "description" : "ID of the user who creates the contact",
1655
+ "pattern" : "([0-9]+)"
1656
+ },
1657
+ "type" : {
1658
+ "type" : [ "string", "null" ],
1659
+ "description" : "Contact type",
1660
+ "x-dynamic-enum" : true
1661
+ },
1662
+ "email" : {
1663
+ "type" : [ "string", "null" ],
1664
+ "description" : "Email ID of the contact",
1665
+ "maxLength" : 255,
1666
+ "minLength" : 0,
1667
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
1668
+ }
1669
+ }
1670
+ },
1671
+ "listViewObject" : {
1672
+ "additionalProperties" : false,
1673
+ "allOf" : [ {
1674
+ "$ref" : "./Contact.json#/components/schemas/commonJson"
1675
+ }, {
1676
+ "type" : [ "null", "object" ],
1677
+ "properties" : {
1678
+ "photoURL" : {
1679
+ "type" : [ "string", "null" ],
1680
+ "maxLength" : 100,
1681
+ "minLength" : 0,
1682
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1683
+ },
1684
+ "isAnonymous" : {
1685
+ "type" : [ "boolean", "null" ]
1686
+ },
1687
+ "accountCount" : {
1688
+ "type" : [ "string", "null", "integer" ],
1689
+ "format" : "int32",
1690
+ "pattern" : "([0-9]+)"
1691
+ },
1692
+ "webUrl" : {
1693
+ "type" : [ "string", "null" ],
1694
+ "maxLength" : 500,
1695
+ "minLength" : 0,
1696
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
1697
+ },
1698
+ "createdTime" : {
1699
+ "type" : [ "string", "null" ],
1700
+ "maxLength" : 100,
1701
+ "minLength" : 0,
1702
+ "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))"
1703
+ },
1704
+ "isEndUser" : {
1705
+ "type" : [ "boolean", "null" ]
1706
+ },
1707
+ "zohoCRMContact" : {
1708
+ "$ref" : "./Contact.json#/components/schemas/zohoCRMContact"
1709
+ },
1710
+ "id" : {
1711
+ "type" : [ "string", "null", "integer" ],
1712
+ "format" : "int64",
1713
+ "pattern" : "([0-9]+)"
1714
+ },
1715
+ "customerHappiness" : {
1716
+ "$ref" : "./Contact.json#/components/schemas/customerHappiness"
1717
+ },
1718
+ "isSpam" : {
1719
+ "type" : [ "boolean", "null" ]
1720
+ }
1721
+ },
1722
+ "required" : [ "accountCount", "createdTime", "customerHappiness", "id", "isAnonymous", "isEndUser", "isSpam", "photoURL", "webUrl", "zohoCRMContact" ]
1723
+ },{"type":"object",
1724
+ "required" : [ "accountId", "email", "firstName", "lastName", "mobile", "ownerId", "phone", "secondaryEmail", "type" ]} ]
1725
+ },
1726
+ "data" : {
1727
+ "type" : [ "null", "array" ],
1728
+ "items" : {
1729
+ "$ref" : "./Contact.json#/components/schemas/listViewObject"
1730
+ }
1731
+ },
1732
+ "long_array" : {
1733
+ "type" : [ "null", "array" ],
1734
+ "items" : {
1735
+ "type" : [ "string", "null", "integer" ],
1736
+ "format" : "int64",
1737
+ "pattern" : "([0-9]+)"
1738
+ }
1739
+ },
1740
+ "customerHappinessCount" : {
1741
+ "type" : [ "null", "object" ],
1742
+ "additionalProperties" : false,
1743
+ "properties" : {
1744
+ "badCount" : {
1745
+ "type" : [ "string", "null", "integer" ],
1746
+ "format" : "int64",
1747
+ "pattern" : "([0-9]+)"
1748
+ },
1749
+ "goodCount" : {
1750
+ "type" : [ "string", "null", "integer" ],
1751
+ "format" : "int64",
1752
+ "pattern" : "([0-9]+)"
1753
+ },
1754
+ "okCount" : {
1755
+ "type" : [ "string", "null", "integer" ],
1756
+ "format" : "int64",
1757
+ "pattern" : "([0-9]+)"
1758
+ }
1759
+ },
1760
+ "required" : [ "badCount", "goodCount", "okCount" ]
1761
+ },
1762
+ "contactjson" : {
1763
+ "additionalProperties" : false,
1764
+ "allOf" : [ {
1765
+ "$ref" : "./Contact.json#/components/schemas/commonJson"
1766
+ }, {
1767
+ "type" : [ "null", "object" ],
1768
+ "properties" : {
1769
+ "zip" : {
1770
+ "type" : [ "string", "null", "integer" ],
1771
+ "format" : "int32",
1772
+ "pattern" : "([0-9]+)",
1773
+ "x-custom-parameters-attributes" : {
1774
+ "removeExif" : false,
1775
+ "filterMatchedContent" : false,
1776
+ "antivirus" : false,
1777
+ "replacementString" : "",
1778
+ "allowInvalid" : false,
1779
+ "descrption" : "Zip code",
1780
+ "secret" : false,
1781
+ "preserveCharsLimit" : 10,
1782
+ "trim" : false,
1783
+ "internalParam" : false,
1784
+ "preserveChars" : "0,5",
1785
+ "importUrl" : false,
1786
+ "decrypt" : false
1787
+ }
1788
+ },
1789
+ "country" : {
1790
+ "type" : [ "string", "null" ],
1791
+ "maxLength" : 30,
1792
+ "minLength" : 0,
1793
+ "x-custom-parameters-attributes" : {
1794
+ "removeExif" : false,
1795
+ "filterMatchedContent" : false,
1796
+ "antivirus" : false,
1797
+ "replacementString" : "",
1798
+ "allowInvalid" : false,
1799
+ "descrption" : "Contact's country of residence",
1800
+ "secret" : false,
1801
+ "preserveCharsLimit" : 10,
1802
+ "trim" : false,
1803
+ "internalParam" : false,
1804
+ "preserveChars" : "0,5",
1805
+ "importUrl" : false,
1806
+ "decrypt" : false
1807
+ }
1808
+ },
1809
+ "twitter" : {
1810
+ "type" : [ "string", "null" ],
1811
+ "maxLength" : 100,
1812
+ "minLength" : 0,
1813
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)",
1814
+ "x-custom-parameters-attributes" : {
1815
+ "removeExif" : false,
1816
+ "filterMatchedContent" : false,
1817
+ "antivirus" : false,
1818
+ "replacementString" : "",
1819
+ "allowInvalid" : false,
1820
+ "descrption" : "Twitter ID of the contact",
1821
+ "secret" : false,
1822
+ "preserveCharsLimit" : 10,
1823
+ "trim" : false,
1824
+ "internalParam" : false,
1825
+ "preserveChars" : "0,5",
1826
+ "importUrl" : false,
1827
+ "decrypt" : false
1828
+ }
1829
+ },
1830
+ "cf" : {
1831
+ "type" : [ "null", "object" ],
1832
+ "additionalProperties" : false,
1833
+ "patternProperties" : {
1834
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
1835
+ "type" : [ "string", "null" ],
1836
+ "maxLength" : 100,
1837
+ "minLength" : 0,
1838
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
1839
+ "x-custom-parameters-attributes" : {
1840
+ "lastName" : {
1841
+ "removeExif" : false,
1842
+ "filterMatchedContent" : false,
1843
+ "antivirus" : false,
1844
+ "replacementString" : "",
1845
+ "allowInvalid" : false,
1846
+ "descrption" : "Last name of the contact",
1847
+ "secret" : false,
1848
+ "preserveCharsLimit" : 10,
1849
+ "trim" : false,
1850
+ "internalParam" : false,
1851
+ "preserveChars" : "0,5",
1852
+ "importUrl" : false,
1853
+ "decrypt" : false
1854
+ },
1855
+ "country" : {
1856
+ "removeExif" : false,
1857
+ "filterMatchedContent" : false,
1858
+ "antivirus" : false,
1859
+ "replacementString" : "",
1860
+ "allowInvalid" : false,
1861
+ "descrption" : "Contact's country of residence",
1862
+ "secret" : false,
1863
+ "preserveCharsLimit" : 10,
1864
+ "trim" : false,
1865
+ "internalParam" : false,
1866
+ "preserveChars" : "0,5",
1867
+ "importUrl" : false,
1868
+ "decrypt" : false
1869
+ },
1870
+ "modifiedTime" : {
1871
+ "removeExif" : false,
1872
+ "filterMatchedContent" : false,
1873
+ "antivirus" : false,
1874
+ "replacementString" : "",
1875
+ "allowInvalid" : false,
1876
+ "descrption" : "Time of modifying the contact",
1877
+ "secret" : false,
1878
+ "preserveCharsLimit" : 10,
1879
+ "trim" : false,
1880
+ "internalParam" : false,
1881
+ "preserveChars" : "0,5",
1882
+ "importUrl" : false,
1883
+ "decrypt" : false
1884
+ },
1885
+ "secondaryEmail" : {
1886
+ "removeExif" : false,
1887
+ "filterMatchedContent" : false,
1888
+ "antivirus" : false,
1889
+ "replacementString" : "",
1890
+ "allowInvalid" : false,
1891
+ "descrption" : "Secondary email ID of the contact",
1892
+ "secret" : false,
1893
+ "preserveCharsLimit" : 10,
1894
+ "trim" : false,
1895
+ "internalParam" : false,
1896
+ "preserveChars" : "0,5",
1897
+ "importUrl" : false,
1898
+ "decrypt" : false
1899
+ },
1900
+ "city" : {
1901
+ "removeExif" : false,
1902
+ "filterMatchedContent" : false,
1903
+ "antivirus" : false,
1904
+ "replacementString" : "",
1905
+ "allowInvalid" : false,
1906
+ "descrption" : "Contact's city of residence",
1907
+ "secret" : false,
1908
+ "preserveCharsLimit" : 10,
1909
+ "trim" : false,
1910
+ "internalParam" : false,
1911
+ "preserveChars" : "0,5",
1912
+ "importUrl" : false,
1913
+ "decrypt" : false
1914
+ },
1915
+ "customFields" : { },
1916
+ "description" : {
1917
+ "removeExif" : false,
1918
+ "filterMatchedContent" : false,
1919
+ "antivirus" : false,
1920
+ "replacementString" : "",
1921
+ "allowInvalid" : false,
1922
+ "descrption" : "Contact description",
1923
+ "secret" : false,
1924
+ "preserveCharsLimit" : 10,
1925
+ "trim" : false,
1926
+ "internalParam" : false,
1927
+ "preserveChars" : "0,5",
1928
+ "importUrl" : false,
1929
+ "decrypt" : false
1930
+ },
1931
+ "title" : {
1932
+ "removeExif" : false,
1933
+ "filterMatchedContent" : false,
1934
+ "antivirus" : false,
1935
+ "replacementString" : "",
1936
+ "allowInvalid" : false,
1937
+ "descrption" : "Contact title",
1938
+ "secret" : false,
1939
+ "preserveCharsLimit" : 10,
1940
+ "trim" : false,
1941
+ "internalParam" : false,
1942
+ "preserveChars" : "0,5",
1943
+ "importUrl" : false,
1944
+ "decrypt" : false
1945
+ },
1946
+ "type" : {
1947
+ "removeExif" : false,
1948
+ "filterMatchedContent" : false,
1949
+ "antivirus" : false,
1950
+ "replacementString" : "",
1951
+ "allowInvalid" : false,
1952
+ "descrption" : "Contact type",
1953
+ "secret" : false,
1954
+ "preserveCharsLimit" : 10,
1955
+ "trim" : false,
1956
+ "internalParam" : false,
1957
+ "preserveChars" : "0,5",
1958
+ "importUrl" : false,
1959
+ "decrypt" : false
1960
+ },
1961
+ "ownerId" : {
1962
+ "removeExif" : false,
1963
+ "filterMatchedContent" : false,
1964
+ "antivirus" : false,
1965
+ "replacementString" : "",
1966
+ "allowInvalid" : false,
1967
+ "descrption" : "ID of the user who creates the contact",
1968
+ "secret" : false,
1969
+ "preserveCharsLimit" : 10,
1970
+ "trim" : false,
1971
+ "internalParam" : false,
1972
+ "preserveChars" : "0,5",
1973
+ "importUrl" : false,
1974
+ "decrypt" : false
1975
+ },
1976
+ "photoURL" : {
1977
+ "removeExif" : false,
1978
+ "filterMatchedContent" : false,
1979
+ "antivirus" : false,
1980
+ "replacementString" : "",
1981
+ "allowInvalid" : false,
1982
+ "descrption" : "URL of the file containing the image of the contact",
1983
+ "secret" : false,
1984
+ "preserveCharsLimit" : 10,
1985
+ "trim" : false,
1986
+ "internalParam" : false,
1987
+ "preserveChars" : "0,5",
1988
+ "importUrl" : false,
1989
+ "decrypt" : false
1990
+ },
1991
+ "twitter" : {
1992
+ "removeExif" : false,
1993
+ "filterMatchedContent" : false,
1994
+ "antivirus" : false,
1995
+ "replacementString" : "",
1996
+ "allowInvalid" : false,
1997
+ "descrption" : "Twitter ID of the contact",
1998
+ "secret" : false,
1999
+ "preserveCharsLimit" : 10,
2000
+ "trim" : false,
2001
+ "internalParam" : false,
2002
+ "preserveChars" : "0,5",
2003
+ "importUrl" : false,
2004
+ "decrypt" : false
2005
+ },
2006
+ "isDeleted" : {
2007
+ "removeExif" : false,
2008
+ "filterMatchedContent" : false,
2009
+ "antivirus" : false,
2010
+ "replacementString" : "",
2011
+ "allowInvalid" : false,
2012
+ "descrption" : "Key that returns if the contact is deleted or not",
2013
+ "secret" : false,
2014
+ "preserveCharsLimit" : 10,
2015
+ "trim" : false,
2016
+ "internalParam" : false,
2017
+ "preserveChars" : "0,5",
2018
+ "importUrl" : false,
2019
+ "decrypt" : false
2020
+ },
2021
+ "isTrashed" : {
2022
+ "removeExif" : false,
2023
+ "filterMatchedContent" : false,
2024
+ "antivirus" : false,
2025
+ "replacementString" : "",
2026
+ "allowInvalid" : false,
2027
+ "descrption" : "Field that denotes whether the contact is in trash",
2028
+ "secret" : false,
2029
+ "preserveCharsLimit" : 10,
2030
+ "trim" : false,
2031
+ "internalParam" : false,
2032
+ "preserveChars" : "0,5",
2033
+ "importUrl" : false,
2034
+ "decrypt" : false
2035
+ },
2036
+ "street" : {
2037
+ "removeExif" : false,
2038
+ "filterMatchedContent" : false,
2039
+ "antivirus" : false,
2040
+ "replacementString" : "",
2041
+ "allowInvalid" : false,
2042
+ "descrption" : "Contact's address",
2043
+ "secret" : false,
2044
+ "preserveCharsLimit" : 10,
2045
+ "trim" : false,
2046
+ "internalParam" : false,
2047
+ "preserveChars" : "0,5",
2048
+ "importUrl" : false,
2049
+ "decrypt" : false
2050
+ },
2051
+ "createdTime" : {
2052
+ "removeExif" : false,
2053
+ "filterMatchedContent" : false,
2054
+ "antivirus" : false,
2055
+ "replacementString" : "",
2056
+ "allowInvalid" : false,
2057
+ "descrption" : "Time of creating the contact",
2058
+ "secret" : false,
2059
+ "preserveCharsLimit" : 10,
2060
+ "trim" : false,
2061
+ "internalParam" : false,
2062
+ "preserveChars" : "0,5",
2063
+ "importUrl" : false,
2064
+ "decrypt" : false
2065
+ },
2066
+ "zohoCRMContact" : {
2067
+ "type" : {
2068
+ "removeExif" : false,
2069
+ "filterMatchedContent" : false,
2070
+ "antivirus" : false,
2071
+ "replacementString" : "",
2072
+ "allowInvalid" : false,
2073
+ "descrption" : "Contact type in Zoho CRM. Values supported are new, @potentials@, @customers@, @contacts@, and @leads@.",
2074
+ "secret" : false,
2075
+ "preserveCharsLimit" : 10,
2076
+ "trim" : false,
2077
+ "internalParam" : false,
2078
+ "preserveChars" : "0,5",
2079
+ "importUrl" : false,
2080
+ "decrypt" : false
2081
+ },
2082
+ "id" : {
2083
+ "removeExif" : false,
2084
+ "filterMatchedContent" : false,
2085
+ "antivirus" : false,
2086
+ "replacementString" : "",
2087
+ "allowInvalid" : false,
2088
+ "descrption" : "ID of the contact in Zoho CRM",
2089
+ "secret" : false,
2090
+ "preserveCharsLimit" : 10,
2091
+ "trim" : false,
2092
+ "internalParam" : false,
2093
+ "preserveChars" : "0,5",
2094
+ "importUrl" : false,
2095
+ "decrypt" : false
2096
+ }
2097
+ },
2098
+ "id" : {
2099
+ "removeExif" : false,
2100
+ "filterMatchedContent" : false,
2101
+ "antivirus" : false,
2102
+ "replacementString" : "",
2103
+ "allowInvalid" : false,
2104
+ "descrption" : "ID of the contact",
2105
+ "secret" : false,
2106
+ "preserveCharsLimit" : 10,
2107
+ "trim" : false,
2108
+ "internalParam" : false,
2109
+ "preserveChars" : "0,5",
2110
+ "importUrl" : false,
2111
+ "decrypt" : false
2112
+ },
2113
+ "state" : {
2114
+ "removeExif" : false,
2115
+ "filterMatchedContent" : false,
2116
+ "antivirus" : false,
2117
+ "replacementString" : "",
2118
+ "allowInvalid" : false,
2119
+ "descrption" : "Contact's state of residence",
2120
+ "secret" : false,
2121
+ "preserveCharsLimit" : 10,
2122
+ "trim" : false,
2123
+ "internalParam" : false,
2124
+ "preserveChars" : "0,5",
2125
+ "importUrl" : false,
2126
+ "decrypt" : false
2127
+ },
2128
+ "customerHappiness" : {
2129
+ "badPercentage" : {
2130
+ "removeExif" : false,
2131
+ "filterMatchedContent" : false,
2132
+ "antivirus" : false,
2133
+ "replacementString" : "",
2134
+ "allowInvalid" : false,
2135
+ "descrption" : "Percentage of negative ratings given by the contact",
2136
+ "secret" : false,
2137
+ "preserveCharsLimit" : 10,
2138
+ "trim" : false,
2139
+ "internalParam" : false,
2140
+ "preserveChars" : "0,5",
2141
+ "importUrl" : false,
2142
+ "decrypt" : false
2143
+ },
2144
+ "okPercentage" : {
2145
+ "removeExif" : false,
2146
+ "filterMatchedContent" : false,
2147
+ "antivirus" : false,
2148
+ "replacementString" : "",
2149
+ "allowInvalid" : false,
2150
+ "descrption" : "Percentage of ok ratings given by the contact",
2151
+ "secret" : false,
2152
+ "preserveCharsLimit" : 10,
2153
+ "trim" : false,
2154
+ "internalParam" : false,
2155
+ "preserveChars" : "0,5",
2156
+ "importUrl" : false,
2157
+ "decrypt" : false
2158
+ },
2159
+ "goodPercentage" : {
2160
+ "removeExif" : false,
2161
+ "filterMatchedContent" : false,
2162
+ "antivirus" : false,
2163
+ "replacementString" : "",
2164
+ "allowInvalid" : false,
2165
+ "descrption" : "Percentage of positive ratings given by the contact",
2166
+ "secret" : false,
2167
+ "preserveCharsLimit" : 10,
2168
+ "trim" : false,
2169
+ "internalParam" : false,
2170
+ "preserveChars" : "0,5",
2171
+ "importUrl" : false,
2172
+ "decrypt" : false
2173
+ }
2174
+ },
2175
+ "email" : {
2176
+ "removeExif" : false,
2177
+ "filterMatchedContent" : false,
2178
+ "antivirus" : false,
2179
+ "replacementString" : "",
2180
+ "allowInvalid" : false,
2181
+ "descrption" : "Email ID of the contact",
2182
+ "secret" : false,
2183
+ "preserveCharsLimit" : 10,
2184
+ "trim" : true,
2185
+ "internalParam" : false,
2186
+ "preserveChars" : "0,5",
2187
+ "importUrl" : false,
2188
+ "decrypt" : false
2189
+ },
2190
+ "zip" : {
2191
+ "removeExif" : false,
2192
+ "filterMatchedContent" : false,
2193
+ "antivirus" : false,
2194
+ "replacementString" : "",
2195
+ "allowInvalid" : false,
2196
+ "descrption" : "Zip code",
2197
+ "secret" : false,
2198
+ "preserveCharsLimit" : 10,
2199
+ "trim" : false,
2200
+ "internalParam" : false,
2201
+ "preserveChars" : "0,5",
2202
+ "importUrl" : false,
2203
+ "decrypt" : false
2204
+ },
2205
+ "owner" : {
2206
+ "firstName" : {
2207
+ "removeExif" : false,
2208
+ "filterMatchedContent" : false,
2209
+ "antivirus" : false,
2210
+ "replacementString" : "",
2211
+ "allowInvalid" : false,
2212
+ "descrption" : "First name of the user",
2213
+ "secret" : false,
2214
+ "preserveCharsLimit" : 10,
2215
+ "trim" : false,
2216
+ "internalParam" : false,
2217
+ "preserveChars" : "0,5",
2218
+ "importUrl" : false,
2219
+ "decrypt" : false
2220
+ },
2221
+ "lastName" : {
2222
+ "removeExif" : false,
2223
+ "filterMatchedContent" : false,
2224
+ "antivirus" : false,
2225
+ "replacementString" : "",
2226
+ "allowInvalid" : false,
2227
+ "descrption" : "Last name of the user",
2228
+ "secret" : false,
2229
+ "preserveCharsLimit" : 10,
2230
+ "trim" : false,
2231
+ "internalParam" : false,
2232
+ "preserveChars" : "0,5",
2233
+ "importUrl" : false,
2234
+ "decrypt" : false
2235
+ },
2236
+ "id" : {
2237
+ "removeExif" : false,
2238
+ "filterMatchedContent" : false,
2239
+ "antivirus" : false,
2240
+ "replacementString" : "",
2241
+ "allowInvalid" : false,
2242
+ "descrption" : "ID of the use",
2243
+ "secret" : false,
2244
+ "preserveCharsLimit" : 10,
2245
+ "trim" : false,
2246
+ "internalParam" : false,
2247
+ "preserveChars" : "0,5",
2248
+ "importUrl" : false,
2249
+ "decrypt" : false
2250
+ }
2251
+ },
2252
+ "cf" : { },
2253
+ "facebook" : {
2254
+ "removeExif" : false,
2255
+ "filterMatchedContent" : false,
2256
+ "antivirus" : false,
2257
+ "replacementString" : "",
2258
+ "allowInvalid" : false,
2259
+ "descrption" : "Facebook ID of the contact",
2260
+ "secret" : false,
2261
+ "preserveCharsLimit" : 10,
2262
+ "trim" : false,
2263
+ "internalParam" : false,
2264
+ "preserveChars" : "0,5",
2265
+ "importUrl" : false,
2266
+ "decrypt" : false
2267
+ },
2268
+ "mobile" : {
2269
+ "removeExif" : false,
2270
+ "filterMatchedContent" : true,
2271
+ "antivirus" : false,
2272
+ "replacementString" : "",
2273
+ "allowInvalid" : false,
2274
+ "descrption" : "Mobile number of the contact",
2275
+ "secret" : false,
2276
+ "preserveCharsLimit" : 10,
2277
+ "trim" : false,
2278
+ "internalParam" : false,
2279
+ "preserveChars" : "0,5",
2280
+ "importUrl" : false,
2281
+ "decrypt" : false
2282
+ },
2283
+ "layoutId" : {
2284
+ "removeExif" : false,
2285
+ "filterMatchedContent" : false,
2286
+ "antivirus" : false,
2287
+ "replacementString" : "",
2288
+ "allowInvalid" : false,
2289
+ "descrption" : "Layout of Contact",
2290
+ "secret" : false,
2291
+ "preserveCharsLimit" : 10,
2292
+ "trim" : false,
2293
+ "internalParam" : true,
2294
+ "preserveChars" : "0,5",
2295
+ "importUrl" : false,
2296
+ "decrypt" : false
2297
+ },
2298
+ "firstName" : {
2299
+ "removeExif" : false,
2300
+ "filterMatchedContent" : false,
2301
+ "antivirus" : false,
2302
+ "replacementString" : "",
2303
+ "allowInvalid" : false,
2304
+ "descrption" : "First name of the contact",
2305
+ "secret" : false,
2306
+ "preserveCharsLimit" : 10,
2307
+ "trim" : false,
2308
+ "internalParam" : false,
2309
+ "preserveChars" : "0,5",
2310
+ "importUrl" : false,
2311
+ "decrypt" : false
2312
+ },
2313
+ "accountId" : {
2314
+ "removeExif" : false,
2315
+ "filterMatchedContent" : false,
2316
+ "antivirus" : false,
2317
+ "replacementString" : "",
2318
+ "allowInvalid" : false,
2319
+ "descrption" : "Account to which the contact is mapped",
2320
+ "secret" : false,
2321
+ "preserveCharsLimit" : 10,
2322
+ "trim" : false,
2323
+ "internalParam" : false,
2324
+ "preserveChars" : "0,5",
2325
+ "importUrl" : false,
2326
+ "decrypt" : false,
2327
+ "entity" : "Accounts"
2328
+ },
2329
+ "phone" : {
2330
+ "removeExif" : false,
2331
+ "filterMatchedContent" : true,
2332
+ "antivirus" : false,
2333
+ "replacementString" : "",
2334
+ "allowInvalid" : false,
2335
+ "descrption" : "Phone number of the contact",
2336
+ "secret" : false,
2337
+ "preserveCharsLimit" : 10,
2338
+ "trim" : false,
2339
+ "internalParam" : false,
2340
+ "preserveChars" : "0,5",
2341
+ "importUrl" : false,
2342
+ "decrypt" : false
2343
+ },
2344
+ "webUrl" : {
2345
+ "removeExif" : false,
2346
+ "filterMatchedContent" : false,
2347
+ "antivirus" : false,
2348
+ "replacementString" : "",
2349
+ "allowInvalid" : false,
2350
+ "descrption" : "URL to access the resource",
2351
+ "secret" : false,
2352
+ "preserveCharsLimit" : 10,
2353
+ "trim" : false,
2354
+ "internalParam" : false,
2355
+ "preserveChars" : "0,5",
2356
+ "importUrl" : false,
2357
+ "decrypt" : false
2358
+ },
2359
+ "isSpam" : {
2360
+ "removeExif" : false,
2361
+ "filterMatchedContent" : false,
2362
+ "antivirus" : false,
2363
+ "replacementString" : "",
2364
+ "allowInvalid" : false,
2365
+ "descrption" : "Field that denotes whether the contact is spam",
2366
+ "secret" : false,
2367
+ "preserveCharsLimit" : 10,
2368
+ "trim" : false,
2369
+ "internalParam" : false,
2370
+ "preserveChars" : "0,5",
2371
+ "importUrl" : false,
2372
+ "decrypt" : false
2373
+ }
2374
+ }
2375
+ }
2376
+ }
2377
+ },
2378
+ "city" : {
2379
+ "type" : [ "string", "null" ],
2380
+ "maxLength" : 30,
2381
+ "minLength" : 0,
2382
+ "x-custom-parameters-attributes" : {
2383
+ "removeExif" : false,
2384
+ "filterMatchedContent" : false,
2385
+ "antivirus" : false,
2386
+ "replacementString" : "",
2387
+ "allowInvalid" : false,
2388
+ "descrption" : "Contact's city of residence",
2389
+ "secret" : false,
2390
+ "preserveCharsLimit" : 10,
2391
+ "trim" : false,
2392
+ "internalParam" : false,
2393
+ "preserveChars" : "0,5",
2394
+ "importUrl" : false,
2395
+ "decrypt" : false
2396
+ }
2397
+ },
2398
+ "customFields" : {
2399
+ "type" : [ "null", "object" ],
2400
+ "additionalProperties" : false,
2401
+ "patternProperties" : {
2402
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
2403
+ "type" : [ "string", "null" ],
2404
+ "maxLength" : 100,
2405
+ "minLength" : 0,
2406
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
2407
+ "x-custom-parameters-attributes" : {
2408
+ "lastName" : {
2409
+ "removeExif" : false,
2410
+ "filterMatchedContent" : false,
2411
+ "antivirus" : false,
2412
+ "replacementString" : "",
2413
+ "allowInvalid" : false,
2414
+ "descrption" : "Last name of the contact",
2415
+ "secret" : false,
2416
+ "preserveCharsLimit" : 10,
2417
+ "trim" : false,
2418
+ "internalParam" : false,
2419
+ "preserveChars" : "0,5",
2420
+ "importUrl" : false,
2421
+ "decrypt" : false
2422
+ },
2423
+ "country" : {
2424
+ "removeExif" : false,
2425
+ "filterMatchedContent" : false,
2426
+ "antivirus" : false,
2427
+ "replacementString" : "",
2428
+ "allowInvalid" : false,
2429
+ "descrption" : "Contact's country of residence",
2430
+ "secret" : false,
2431
+ "preserveCharsLimit" : 10,
2432
+ "trim" : false,
2433
+ "internalParam" : false,
2434
+ "preserveChars" : "0,5",
2435
+ "importUrl" : false,
2436
+ "decrypt" : false
2437
+ },
2438
+ "modifiedTime" : {
2439
+ "removeExif" : false,
2440
+ "filterMatchedContent" : false,
2441
+ "antivirus" : false,
2442
+ "replacementString" : "",
2443
+ "allowInvalid" : false,
2444
+ "descrption" : "Time of modifying the contact",
2445
+ "secret" : false,
2446
+ "preserveCharsLimit" : 10,
2447
+ "trim" : false,
2448
+ "internalParam" : false,
2449
+ "preserveChars" : "0,5",
2450
+ "importUrl" : false,
2451
+ "decrypt" : false
2452
+ },
2453
+ "secondaryEmail" : {
2454
+ "removeExif" : false,
2455
+ "filterMatchedContent" : false,
2456
+ "antivirus" : false,
2457
+ "replacementString" : "",
2458
+ "allowInvalid" : false,
2459
+ "descrption" : "Secondary email ID of the contact",
2460
+ "secret" : false,
2461
+ "preserveCharsLimit" : 10,
2462
+ "trim" : false,
2463
+ "internalParam" : false,
2464
+ "preserveChars" : "0,5",
2465
+ "importUrl" : false,
2466
+ "decrypt" : false
2467
+ },
2468
+ "city" : {
2469
+ "removeExif" : false,
2470
+ "filterMatchedContent" : false,
2471
+ "antivirus" : false,
2472
+ "replacementString" : "",
2473
+ "allowInvalid" : false,
2474
+ "descrption" : "Contact's city of residence",
2475
+ "secret" : false,
2476
+ "preserveCharsLimit" : 10,
2477
+ "trim" : false,
2478
+ "internalParam" : false,
2479
+ "preserveChars" : "0,5",
2480
+ "importUrl" : false,
2481
+ "decrypt" : false
2482
+ },
2483
+ "customFields" : { },
2484
+ "description" : {
2485
+ "removeExif" : false,
2486
+ "filterMatchedContent" : false,
2487
+ "antivirus" : false,
2488
+ "replacementString" : "",
2489
+ "allowInvalid" : false,
2490
+ "descrption" : "Contact description",
2491
+ "secret" : false,
2492
+ "preserveCharsLimit" : 10,
2493
+ "trim" : false,
2494
+ "internalParam" : false,
2495
+ "preserveChars" : "0,5",
2496
+ "importUrl" : false,
2497
+ "decrypt" : false
2498
+ },
2499
+ "title" : {
2500
+ "removeExif" : false,
2501
+ "filterMatchedContent" : false,
2502
+ "antivirus" : false,
2503
+ "replacementString" : "",
2504
+ "allowInvalid" : false,
2505
+ "descrption" : "Contact title",
2506
+ "secret" : false,
2507
+ "preserveCharsLimit" : 10,
2508
+ "trim" : false,
2509
+ "internalParam" : false,
2510
+ "preserveChars" : "0,5",
2511
+ "importUrl" : false,
2512
+ "decrypt" : false
2513
+ },
2514
+ "type" : {
2515
+ "removeExif" : false,
2516
+ "filterMatchedContent" : false,
2517
+ "antivirus" : false,
2518
+ "replacementString" : "",
2519
+ "allowInvalid" : false,
2520
+ "descrption" : "Contact type",
2521
+ "secret" : false,
2522
+ "preserveCharsLimit" : 10,
2523
+ "trim" : false,
2524
+ "internalParam" : false,
2525
+ "preserveChars" : "0,5",
2526
+ "importUrl" : false,
2527
+ "decrypt" : false
2528
+ },
2529
+ "ownerId" : {
2530
+ "removeExif" : false,
2531
+ "filterMatchedContent" : false,
2532
+ "antivirus" : false,
2533
+ "replacementString" : "",
2534
+ "allowInvalid" : false,
2535
+ "descrption" : "ID of the user who creates the contact",
2536
+ "secret" : false,
2537
+ "preserveCharsLimit" : 10,
2538
+ "trim" : false,
2539
+ "internalParam" : false,
2540
+ "preserveChars" : "0,5",
2541
+ "importUrl" : false,
2542
+ "decrypt" : false
2543
+ },
2544
+ "photoURL" : {
2545
+ "removeExif" : false,
2546
+ "filterMatchedContent" : false,
2547
+ "antivirus" : false,
2548
+ "replacementString" : "",
2549
+ "allowInvalid" : false,
2550
+ "descrption" : "URL of the file containing the image of the contact",
2551
+ "secret" : false,
2552
+ "preserveCharsLimit" : 10,
2553
+ "trim" : false,
2554
+ "internalParam" : false,
2555
+ "preserveChars" : "0,5",
2556
+ "importUrl" : false,
2557
+ "decrypt" : false
2558
+ },
2559
+ "twitter" : {
2560
+ "removeExif" : false,
2561
+ "filterMatchedContent" : false,
2562
+ "antivirus" : false,
2563
+ "replacementString" : "",
2564
+ "allowInvalid" : false,
2565
+ "descrption" : "Twitter ID of the contact",
2566
+ "secret" : false,
2567
+ "preserveCharsLimit" : 10,
2568
+ "trim" : false,
2569
+ "internalParam" : false,
2570
+ "preserveChars" : "0,5",
2571
+ "importUrl" : false,
2572
+ "decrypt" : false
2573
+ },
2574
+ "isDeleted" : {
2575
+ "removeExif" : false,
2576
+ "filterMatchedContent" : false,
2577
+ "antivirus" : false,
2578
+ "replacementString" : "",
2579
+ "allowInvalid" : false,
2580
+ "descrption" : "Key that returns if the contact is deleted or not",
2581
+ "secret" : false,
2582
+ "preserveCharsLimit" : 10,
2583
+ "trim" : false,
2584
+ "internalParam" : false,
2585
+ "preserveChars" : "0,5",
2586
+ "importUrl" : false,
2587
+ "decrypt" : false
2588
+ },
2589
+ "isTrashed" : {
2590
+ "removeExif" : false,
2591
+ "filterMatchedContent" : false,
2592
+ "antivirus" : false,
2593
+ "replacementString" : "",
2594
+ "allowInvalid" : false,
2595
+ "descrption" : "Field that denotes whether the contact is in trash",
2596
+ "secret" : false,
2597
+ "preserveCharsLimit" : 10,
2598
+ "trim" : false,
2599
+ "internalParam" : false,
2600
+ "preserveChars" : "0,5",
2601
+ "importUrl" : false,
2602
+ "decrypt" : false
2603
+ },
2604
+ "street" : {
2605
+ "removeExif" : false,
2606
+ "filterMatchedContent" : false,
2607
+ "antivirus" : false,
2608
+ "replacementString" : "",
2609
+ "allowInvalid" : false,
2610
+ "descrption" : "Contact's address",
2611
+ "secret" : false,
2612
+ "preserveCharsLimit" : 10,
2613
+ "trim" : false,
2614
+ "internalParam" : false,
2615
+ "preserveChars" : "0,5",
2616
+ "importUrl" : false,
2617
+ "decrypt" : false
2618
+ },
2619
+ "createdTime" : {
2620
+ "removeExif" : false,
2621
+ "filterMatchedContent" : false,
2622
+ "antivirus" : false,
2623
+ "replacementString" : "",
2624
+ "allowInvalid" : false,
2625
+ "descrption" : "Time of creating the contact",
2626
+ "secret" : false,
2627
+ "preserveCharsLimit" : 10,
2628
+ "trim" : false,
2629
+ "internalParam" : false,
2630
+ "preserveChars" : "0,5",
2631
+ "importUrl" : false,
2632
+ "decrypt" : false
2633
+ },
2634
+ "zohoCRMContact" : {
2635
+ "type" : {
2636
+ "removeExif" : false,
2637
+ "filterMatchedContent" : false,
2638
+ "antivirus" : false,
2639
+ "replacementString" : "",
2640
+ "allowInvalid" : false,
2641
+ "descrption" : "Contact type in Zoho CRM. Values supported are new, @potentials@, @customers@, @contacts@, and @leads@.",
2642
+ "secret" : false,
2643
+ "preserveCharsLimit" : 10,
2644
+ "trim" : false,
2645
+ "internalParam" : false,
2646
+ "preserveChars" : "0,5",
2647
+ "importUrl" : false,
2648
+ "decrypt" : false
2649
+ },
2650
+ "id" : {
2651
+ "removeExif" : false,
2652
+ "filterMatchedContent" : false,
2653
+ "antivirus" : false,
2654
+ "replacementString" : "",
2655
+ "allowInvalid" : false,
2656
+ "descrption" : "ID of the contact in Zoho CRM",
2657
+ "secret" : false,
2658
+ "preserveCharsLimit" : 10,
2659
+ "trim" : false,
2660
+ "internalParam" : false,
2661
+ "preserveChars" : "0,5",
2662
+ "importUrl" : false,
2663
+ "decrypt" : false
2664
+ }
2665
+ },
2666
+ "id" : {
2667
+ "removeExif" : false,
2668
+ "filterMatchedContent" : false,
2669
+ "antivirus" : false,
2670
+ "replacementString" : "",
2671
+ "allowInvalid" : false,
2672
+ "descrption" : "ID of the contact",
2673
+ "secret" : false,
2674
+ "preserveCharsLimit" : 10,
2675
+ "trim" : false,
2676
+ "internalParam" : false,
2677
+ "preserveChars" : "0,5",
2678
+ "importUrl" : false,
2679
+ "decrypt" : false
2680
+ },
2681
+ "state" : {
2682
+ "removeExif" : false,
2683
+ "filterMatchedContent" : false,
2684
+ "antivirus" : false,
2685
+ "replacementString" : "",
2686
+ "allowInvalid" : false,
2687
+ "descrption" : "Contact's state of residence",
2688
+ "secret" : false,
2689
+ "preserveCharsLimit" : 10,
2690
+ "trim" : false,
2691
+ "internalParam" : false,
2692
+ "preserveChars" : "0,5",
2693
+ "importUrl" : false,
2694
+ "decrypt" : false
2695
+ },
2696
+ "customerHappiness" : {
2697
+ "badPercentage" : {
2698
+ "removeExif" : false,
2699
+ "filterMatchedContent" : false,
2700
+ "antivirus" : false,
2701
+ "replacementString" : "",
2702
+ "allowInvalid" : false,
2703
+ "descrption" : "Percentage of negative ratings given by the contact",
2704
+ "secret" : false,
2705
+ "preserveCharsLimit" : 10,
2706
+ "trim" : false,
2707
+ "internalParam" : false,
2708
+ "preserveChars" : "0,5",
2709
+ "importUrl" : false,
2710
+ "decrypt" : false
2711
+ },
2712
+ "okPercentage" : {
2713
+ "removeExif" : false,
2714
+ "filterMatchedContent" : false,
2715
+ "antivirus" : false,
2716
+ "replacementString" : "",
2717
+ "allowInvalid" : false,
2718
+ "descrption" : "Percentage of ok ratings given by the contact",
2719
+ "secret" : false,
2720
+ "preserveCharsLimit" : 10,
2721
+ "trim" : false,
2722
+ "internalParam" : false,
2723
+ "preserveChars" : "0,5",
2724
+ "importUrl" : false,
2725
+ "decrypt" : false
2726
+ },
2727
+ "goodPercentage" : {
2728
+ "removeExif" : false,
2729
+ "filterMatchedContent" : false,
2730
+ "antivirus" : false,
2731
+ "replacementString" : "",
2732
+ "allowInvalid" : false,
2733
+ "descrption" : "Percentage of positive ratings given by the contact",
2734
+ "secret" : false,
2735
+ "preserveCharsLimit" : 10,
2736
+ "trim" : false,
2737
+ "internalParam" : false,
2738
+ "preserveChars" : "0,5",
2739
+ "importUrl" : false,
2740
+ "decrypt" : false
2741
+ }
2742
+ },
2743
+ "email" : {
2744
+ "removeExif" : false,
2745
+ "filterMatchedContent" : false,
2746
+ "antivirus" : false,
2747
+ "replacementString" : "",
2748
+ "allowInvalid" : false,
2749
+ "descrption" : "Email ID of the contact",
2750
+ "secret" : false,
2751
+ "preserveCharsLimit" : 10,
2752
+ "trim" : true,
2753
+ "internalParam" : false,
2754
+ "preserveChars" : "0,5",
2755
+ "importUrl" : false,
2756
+ "decrypt" : false
2757
+ },
2758
+ "zip" : {
2759
+ "removeExif" : false,
2760
+ "filterMatchedContent" : false,
2761
+ "antivirus" : false,
2762
+ "replacementString" : "",
2763
+ "allowInvalid" : false,
2764
+ "descrption" : "Zip code",
2765
+ "secret" : false,
2766
+ "preserveCharsLimit" : 10,
2767
+ "trim" : false,
2768
+ "internalParam" : false,
2769
+ "preserveChars" : "0,5",
2770
+ "importUrl" : false,
2771
+ "decrypt" : false
2772
+ },
2773
+ "owner" : {
2774
+ "firstName" : {
2775
+ "removeExif" : false,
2776
+ "filterMatchedContent" : false,
2777
+ "antivirus" : false,
2778
+ "replacementString" : "",
2779
+ "allowInvalid" : false,
2780
+ "descrption" : "First name of the user",
2781
+ "secret" : false,
2782
+ "preserveCharsLimit" : 10,
2783
+ "trim" : false,
2784
+ "internalParam" : false,
2785
+ "preserveChars" : "0,5",
2786
+ "importUrl" : false,
2787
+ "decrypt" : false
2788
+ },
2789
+ "lastName" : {
2790
+ "removeExif" : false,
2791
+ "filterMatchedContent" : false,
2792
+ "antivirus" : false,
2793
+ "replacementString" : "",
2794
+ "allowInvalid" : false,
2795
+ "descrption" : "Last name of the user",
2796
+ "secret" : false,
2797
+ "preserveCharsLimit" : 10,
2798
+ "trim" : false,
2799
+ "internalParam" : false,
2800
+ "preserveChars" : "0,5",
2801
+ "importUrl" : false,
2802
+ "decrypt" : false
2803
+ },
2804
+ "id" : {
2805
+ "removeExif" : false,
2806
+ "filterMatchedContent" : false,
2807
+ "antivirus" : false,
2808
+ "replacementString" : "",
2809
+ "allowInvalid" : false,
2810
+ "descrption" : "ID of the use",
2811
+ "secret" : false,
2812
+ "preserveCharsLimit" : 10,
2813
+ "trim" : false,
2814
+ "internalParam" : false,
2815
+ "preserveChars" : "0,5",
2816
+ "importUrl" : false,
2817
+ "decrypt" : false
2818
+ }
2819
+ },
2820
+ "cf" : { },
2821
+ "facebook" : {
2822
+ "removeExif" : false,
2823
+ "filterMatchedContent" : false,
2824
+ "antivirus" : false,
2825
+ "replacementString" : "",
2826
+ "allowInvalid" : false,
2827
+ "descrption" : "Facebook ID of the contact",
2828
+ "secret" : false,
2829
+ "preserveCharsLimit" : 10,
2830
+ "trim" : false,
2831
+ "internalParam" : false,
2832
+ "preserveChars" : "0,5",
2833
+ "importUrl" : false,
2834
+ "decrypt" : false
2835
+ },
2836
+ "mobile" : {
2837
+ "removeExif" : false,
2838
+ "filterMatchedContent" : true,
2839
+ "antivirus" : false,
2840
+ "replacementString" : "",
2841
+ "allowInvalid" : false,
2842
+ "descrption" : "Mobile number of the contact",
2843
+ "secret" : false,
2844
+ "preserveCharsLimit" : 10,
2845
+ "trim" : false,
2846
+ "internalParam" : false,
2847
+ "preserveChars" : "0,5",
2848
+ "importUrl" : false,
2849
+ "decrypt" : false
2850
+ },
2851
+ "layoutId" : {
2852
+ "removeExif" : false,
2853
+ "filterMatchedContent" : false,
2854
+ "antivirus" : false,
2855
+ "replacementString" : "",
2856
+ "allowInvalid" : false,
2857
+ "descrption" : "Layout of Contact",
2858
+ "secret" : false,
2859
+ "preserveCharsLimit" : 10,
2860
+ "trim" : false,
2861
+ "internalParam" : true,
2862
+ "preserveChars" : "0,5",
2863
+ "importUrl" : false,
2864
+ "decrypt" : false
2865
+ },
2866
+ "firstName" : {
2867
+ "removeExif" : false,
2868
+ "filterMatchedContent" : false,
2869
+ "antivirus" : false,
2870
+ "replacementString" : "",
2871
+ "allowInvalid" : false,
2872
+ "descrption" : "First name of the contact",
2873
+ "secret" : false,
2874
+ "preserveCharsLimit" : 10,
2875
+ "trim" : false,
2876
+ "internalParam" : false,
2877
+ "preserveChars" : "0,5",
2878
+ "importUrl" : false,
2879
+ "decrypt" : false
2880
+ },
2881
+ "accountId" : {
2882
+ "removeExif" : false,
2883
+ "filterMatchedContent" : false,
2884
+ "antivirus" : false,
2885
+ "replacementString" : "",
2886
+ "allowInvalid" : false,
2887
+ "descrption" : "Account to which the contact is mapped",
2888
+ "secret" : false,
2889
+ "preserveCharsLimit" : 10,
2890
+ "trim" : false,
2891
+ "internalParam" : false,
2892
+ "preserveChars" : "0,5",
2893
+ "importUrl" : false,
2894
+ "decrypt" : false,
2895
+ "entity" : "Accounts"
2896
+ },
2897
+ "phone" : {
2898
+ "removeExif" : false,
2899
+ "filterMatchedContent" : true,
2900
+ "antivirus" : false,
2901
+ "replacementString" : "",
2902
+ "allowInvalid" : false,
2903
+ "descrption" : "Phone number of the contact",
2904
+ "secret" : false,
2905
+ "preserveCharsLimit" : 10,
2906
+ "trim" : false,
2907
+ "internalParam" : false,
2908
+ "preserveChars" : "0,5",
2909
+ "importUrl" : false,
2910
+ "decrypt" : false
2911
+ },
2912
+ "webUrl" : {
2913
+ "removeExif" : false,
2914
+ "filterMatchedContent" : false,
2915
+ "antivirus" : false,
2916
+ "replacementString" : "",
2917
+ "allowInvalid" : false,
2918
+ "descrption" : "URL to access the resource",
2919
+ "secret" : false,
2920
+ "preserveCharsLimit" : 10,
2921
+ "trim" : false,
2922
+ "internalParam" : false,
2923
+ "preserveChars" : "0,5",
2924
+ "importUrl" : false,
2925
+ "decrypt" : false
2926
+ },
2927
+ "isSpam" : {
2928
+ "removeExif" : false,
2929
+ "filterMatchedContent" : false,
2930
+ "antivirus" : false,
2931
+ "replacementString" : "",
2932
+ "allowInvalid" : false,
2933
+ "descrption" : "Field that denotes whether the contact is spam",
2934
+ "secret" : false,
2935
+ "preserveCharsLimit" : 10,
2936
+ "trim" : false,
2937
+ "internalParam" : false,
2938
+ "preserveChars" : "0,5",
2939
+ "importUrl" : false,
2940
+ "decrypt" : false
2941
+ }
2942
+ }
2943
+ }
2944
+ }
2945
+ },
2946
+ "street" : {
2947
+ "type" : [ "string", "null" ],
2948
+ "maxLength" : 250,
2949
+ "minLength" : 0,
2950
+ "x-custom-parameters-attributes" : {
2951
+ "removeExif" : false,
2952
+ "filterMatchedContent" : false,
2953
+ "antivirus" : false,
2954
+ "replacementString" : "",
2955
+ "allowInvalid" : false,
2956
+ "descrption" : "Contact's address",
2957
+ "secret" : false,
2958
+ "preserveCharsLimit" : 10,
2959
+ "trim" : false,
2960
+ "internalParam" : false,
2961
+ "preserveChars" : "0,5",
2962
+ "importUrl" : false,
2963
+ "decrypt" : false
2964
+ }
2965
+ },
2966
+ "facebook" : {
2967
+ "type" : [ "string", "null" ],
2968
+ "maxLength" : 100,
2969
+ "minLength" : 0,
2970
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)",
2971
+ "x-custom-parameters-attributes" : {
2972
+ "removeExif" : false,
2973
+ "filterMatchedContent" : false,
2974
+ "antivirus" : false,
2975
+ "replacementString" : "",
2976
+ "allowInvalid" : false,
2977
+ "descrption" : "Facebook ID of the contact",
2978
+ "secret" : false,
2979
+ "preserveCharsLimit" : 10,
2980
+ "trim" : false,
2981
+ "internalParam" : false,
2982
+ "preserveChars" : "0,5",
2983
+ "importUrl" : false,
2984
+ "decrypt" : false
2985
+ }
2986
+ },
2987
+ "mobile" : {
2988
+ "type" : [ "string", "null" ],
2989
+ "maxLength" : 50,
2990
+ "minLength" : 0,
2991
+ "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
2992
+ "x-custom-parameters-attributes" : {
2993
+ "removeExif" : false,
2994
+ "filterMatchedContent" : true,
2995
+ "antivirus" : false,
2996
+ "replacementString" : "",
2997
+ "allowInvalid" : false,
2998
+ "descrption" : "Mobile number of the contact",
2999
+ "secret" : false,
3000
+ "preserveCharsLimit" : 10,
3001
+ "trim" : false,
3002
+ "internalParam" : false,
3003
+ "preserveChars" : "0,5",
3004
+ "importUrl" : false,
3005
+ "decrypt" : false
3006
+ }
3007
+ },
3008
+ "description" : {
3009
+ "type" : [ "string", "null" ],
3010
+ "maxLength" : 65535,
3011
+ "minLength" : 0,
3012
+ "x-custom-parameters-attributes" : {
3013
+ "removeExif" : false,
3014
+ "filterMatchedContent" : false,
3015
+ "antivirus" : false,
3016
+ "replacementString" : "",
3017
+ "allowInvalid" : false,
3018
+ "descrption" : "Contact description",
3019
+ "secret" : false,
3020
+ "preserveCharsLimit" : 10,
3021
+ "trim" : false,
3022
+ "internalParam" : false,
3023
+ "preserveChars" : "0,5",
3024
+ "importUrl" : false,
3025
+ "decrypt" : false
3026
+ }
3027
+ },
3028
+ "state" : {
3029
+ "type" : [ "string", "null" ],
3030
+ "maxLength" : 30,
3031
+ "minLength" : 0,
3032
+ "x-custom-parameters-attributes" : {
3033
+ "removeExif" : false,
3034
+ "filterMatchedContent" : false,
3035
+ "antivirus" : false,
3036
+ "replacementString" : "",
3037
+ "allowInvalid" : false,
3038
+ "descrption" : "Contact's state of residence",
3039
+ "secret" : false,
3040
+ "preserveCharsLimit" : 10,
3041
+ "trim" : false,
3042
+ "internalParam" : false,
3043
+ "preserveChars" : "0,5",
3044
+ "importUrl" : false,
3045
+ "decrypt" : false
3046
+ }
3047
+ },
3048
+ "title" : {
3049
+ "type" : [ "string", "null" ],
3050
+ "maxLength" : 100,
3051
+ "minLength" : 0,
3052
+ "x-custom-parameters-attributes" : {
3053
+ "removeExif" : false,
3054
+ "filterMatchedContent" : false,
3055
+ "antivirus" : false,
3056
+ "replacementString" : "",
3057
+ "allowInvalid" : false,
3058
+ "descrption" : "Contact title",
3059
+ "secret" : false,
3060
+ "preserveCharsLimit" : 10,
3061
+ "trim" : false,
3062
+ "internalParam" : false,
3063
+ "preserveChars" : "0,5",
3064
+ "importUrl" : false,
3065
+ "decrypt" : false
3066
+ }
3067
+ }
3068
+ },
3069
+ "required" : [ "cf", "city", "country", "customFields", "description", "facebook", "mobile", "state", "street", "title", "twitter", "zip" ]
3070
+ } ]
3071
+ },
3072
+ "sourceValues" : {
3073
+ "type" : [ "null", "object" ],
3074
+ "additionalProperties" : false,
3075
+ "properties" : {
3076
+ "zip" : {
3077
+ "type" : [ "string", "null", "integer" ],
3078
+ "format" : "int64",
3079
+ "pattern" : "([0-9]+)"
3080
+ },
3081
+ "lastName" : {
3082
+ "type" : [ "string", "null", "integer" ],
3083
+ "format" : "int64",
3084
+ "pattern" : "([0-9]+)"
3085
+ },
3086
+ "country" : {
3087
+ "type" : [ "string", "null", "integer" ],
3088
+ "format" : "int64",
3089
+ "pattern" : "([0-9]+)"
3090
+ },
3091
+ "secondaryEmail" : {
3092
+ "type" : [ "string", "null", "integer" ],
3093
+ "format" : "int64",
3094
+ "pattern" : "([0-9]+)"
3095
+ },
3096
+ "cf" : {
3097
+ "type" : [ "null", "object" ],
3098
+ "additionalProperties" : false,
3099
+ "patternProperties" : {
3100
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
3101
+ "type" : [ "string", "null", "integer" ],
3102
+ "format" : "int64",
3103
+ "pattern" : "([0-9]+)"
3104
+ }
3105
+ }
3106
+ },
3107
+ "city" : {
3108
+ "type" : [ "string", "null", "integer" ],
3109
+ "format" : "int64",
3110
+ "pattern" : "([0-9]+)"
3111
+ },
3112
+ "customFields" : {
3113
+ "type" : [ "null", "object" ],
3114
+ "additionalProperties" : false,
3115
+ "patternProperties" : {
3116
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
3117
+ "type" : [ "string", "null", "integer" ],
3118
+ "format" : "int64",
3119
+ "pattern" : "([0-9]+)"
3120
+ }
3121
+ }
3122
+ },
3123
+ "facebook" : {
3124
+ "type" : [ "string", "null", "integer" ],
3125
+ "format" : "int64",
3126
+ "pattern" : "([0-9]+)"
3127
+ },
3128
+ "mobile" : {
3129
+ "type" : [ "string", "null", "integer" ],
3130
+ "format" : "int64",
3131
+ "pattern" : "([0-9]+)"
3132
+ },
3133
+ "description" : {
3134
+ "type" : [ "string", "null", "integer" ],
3135
+ "format" : "int64",
3136
+ "pattern" : "([0-9]+)"
3137
+ },
3138
+ "type" : {
3139
+ "type" : [ "string", "null", "integer" ],
3140
+ "format" : "int64",
3141
+ "pattern" : "([0-9]+)"
3142
+ },
3143
+ "title" : {
3144
+ "type" : [ "string", "null", "integer" ],
3145
+ "format" : "int64",
3146
+ "pattern" : "([0-9]+)"
3147
+ },
3148
+ "firstName" : {
3149
+ "type" : [ "string", "null", "integer" ],
3150
+ "format" : "int64",
3151
+ "pattern" : "([0-9]+)"
3152
+ },
3153
+ "accountId" : {
3154
+ "type" : [ "string", "null", "integer" ],
3155
+ "format" : "int64",
3156
+ "pattern" : "([0-9]+)"
3157
+ },
3158
+ "twitter" : {
3159
+ "type" : [ "string", "null", "integer" ],
3160
+ "format" : "int64",
3161
+ "pattern" : "([0-9]+)"
3162
+ },
3163
+ "phone" : {
3164
+ "type" : [ "string", "null", "integer" ],
3165
+ "format" : "int64",
3166
+ "pattern" : "([0-9]+)"
3167
+ },
3168
+ "street" : {
3169
+ "type" : [ "string", "null", "integer" ],
3170
+ "format" : "int64",
3171
+ "pattern" : "([0-9]+)"
3172
+ },
3173
+ "state" : {
3174
+ "type" : [ "string", "null", "integer" ],
3175
+ "format" : "int64",
3176
+ "pattern" : "([0-9]+)"
3177
+ },
3178
+ "email" : {
3179
+ "type" : [ "string", "null", "integer" ],
3180
+ "format" : "int64",
3181
+ "pattern" : "([0-9]+)"
3182
+ }
3183
+ },
3184
+ "required" : [ "accountId", "cf", "city", "country", "customFields", "description", "email", "facebook", "firstName", "lastName", "mobile", "phone", "secondaryEmail", "state", "street", "title", "twitter", "type", "zip" ]
3185
+ },
3186
+ "mappingInfo" : {
3187
+ "type" : [ "null", "object" ],
3188
+ "additionalProperties" : false,
3189
+ "properties" : {
3190
+ "mappingId" : {
3191
+ "type" : [ "string", "null", "integer" ],
3192
+ "format" : "int64",
3193
+ "pattern" : "([0-9]+)"
3194
+ },
3195
+ "mappingType" : {
3196
+ "type" : [ "string", "null" ],
3197
+ "enum" : [ "PRIMARY", "SECONDARY" ],
3198
+ "maxLength" : 100,
3199
+ "minLength" : 0
3200
+ },
3201
+ "isAccountTicketsViewable" : {
3202
+ "type" : [ "boolean", "null" ]
3203
+ }
3204
+ },
3205
+ "required" : [ "isAccountTicketsViewable", "mappingId", "mappingType" ]
3206
+ },
3207
+ "listViewObjectWithMappingInfo" : {
3208
+ "additionalProperties" : false,
3209
+ "allOf" : [ {
3210
+ "$ref" : "./Contact.json#/components/schemas/listViewObject"
3211
+ }, {
3212
+ "type" : [ "null", "object" ],
3213
+ "properties" : {
3214
+ "mappingInfo" : {
3215
+ "$ref" : "./Contact.json#/components/schemas/mappingInfo"
3216
+ }
3217
+ },
3218
+ "required" : [ "mappingInfo" ]
3219
+ } ]
3220
+ },
3221
+ "dataWithMappingInfo" : {
3222
+ "type" : [ "null", "array" ],
3223
+ "items" : {
3224
+ "$ref" : "./Contact.json#/components/schemas/listViewObjectWithMappingInfo"
3225
+ }
3226
+ }
3227
+ },
3228
+ "responses" : {
3229
+ "contactListViewArray" : {
3230
+ "description" : "contactListViewArray template definitions",
3231
+ "content" : {
3232
+ "application/json" : {
3233
+ "schema" : {
3234
+ "type" : [ "null", "object" ],
3235
+ "additionalProperties" : false,
3236
+ "properties" : {
3237
+ "data" : {
3238
+ "$ref" : "./Contact.json#/components/schemas/data"
3239
+ }
3240
+ },
3241
+ "required" : [ "data" ]
3242
+ },
3243
+ "examples" : {
3244
+ "Valid responses Definitions" : {
3245
+ "value" : {
3246
+ "data" : [ {
3247
+ "lastName" : "Case",
3248
+ "secondaryEmail" : null,
3249
+ "mobile" : "+91 8508569683",
3250
+ "ownerId" : null,
3251
+ "type" : null,
3252
+ "accountId" : "1892000000091433",
3253
+ "firstName" : "Jonathan",
3254
+ "photoURL" : "https://desk.zoho.com/api/v1/contacts/1892000000772003/photo",
3255
+ "isAnonymous" : false,
3256
+ "phone" : "1 888 900 9646",
3257
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
3258
+ "createdTime" : 1507813910000,
3259
+ "isEndUser" : false,
3260
+ "zohoCRMContact" : null,
3261
+ "id" : "1892000000772003",
3262
+ "customerHappiness" : {
3263
+ "badPercentage" : "0",
3264
+ "okPercentage" : "0",
3265
+ "goodPercentage" : "0"
3266
+ },
3267
+ "isSpam" : false,
3268
+ "email" : "case@zylker.com"
3269
+ }, {
3270
+ "lastName" : "Jade",
3271
+ "secondaryEmail" : null,
3272
+ "mobile" : null,
3273
+ "ownerId" : null,
3274
+ "type" : null,
3275
+ "accountId" : "1892000000052077",
3276
+ "firstName" : "Christ",
3277
+ "photoURL" : null,
3278
+ "isAnonymous" : false,
3279
+ "phone" : null,
3280
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
3281
+ "createdTime" : 1507813910000,
3282
+ "isEndUser" : false,
3283
+ "zohoCRMContact" : {
3284
+ "id" : "1892000000772030",
3285
+ "type" : "contacts_leads"
3286
+ },
3287
+ "id" : "1892000000772001",
3288
+ "customerHappiness" : {
3289
+ "badPercentage" : "22",
3290
+ "okPercentage" : "31",
3291
+ "goodPercentage" : "47"
3292
+ },
3293
+ "isSpam" : false,
3294
+ "email" : "jade@zylker.com"
3295
+ } ]
3296
+ }
3297
+ }
3298
+ }
3299
+ }
3300
+ },
3301
+ "x-custom-response-attributes" : {
3302
+ "disable-safe-headers" : "[]"
3303
+ }
3304
+ },
3305
+ "getStatistics" : {
3306
+ "description" : "getStatistics template definitions",
3307
+ "content" : {
3308
+ "application/json" : {
3309
+ "schema" : {
3310
+ "type" : [ "null", "object" ],
3311
+ "additionalProperties" : false,
3312
+ "properties" : {
3313
+ "firstResponseTime" : {
3314
+ "type" : [ "string", "null", "integer" ],
3315
+ "format" : "int64",
3316
+ "pattern" : "([0-9]+)"
3317
+ },
3318
+ "openTickets" : {
3319
+ "type" : [ "string", "null", "integer" ],
3320
+ "format" : "int64",
3321
+ "pattern" : "([0-9]+)"
3322
+ },
3323
+ "responseTime" : {
3324
+ "type" : [ "string", "null", "integer" ],
3325
+ "format" : "int64",
3326
+ "pattern" : "([0-9]+)"
3327
+ },
3328
+ "spamTickets" : {
3329
+ "type" : [ "string", "null", "integer" ],
3330
+ "format" : "int64",
3331
+ "pattern" : "([0-9]+)"
3332
+ },
3333
+ "totalTickets" : {
3334
+ "type" : [ "string", "null", "integer" ],
3335
+ "format" : "int64",
3336
+ "pattern" : "([0-9]+)"
3337
+ },
3338
+ "customerHappiness" : {
3339
+ "$ref" : "./Contact.json#/components/schemas/customerHappinessCount"
3340
+ },
3341
+ "resolutionTime" : {
3342
+ "type" : [ "string", "null", "integer" ],
3343
+ "format" : "int64",
3344
+ "pattern" : "([0-9]+)"
3345
+ },
3346
+ "closedTickets" : {
3347
+ "type" : [ "string", "null", "integer" ],
3348
+ "format" : "int64",
3349
+ "pattern" : "([0-9]+)"
3350
+ },
3351
+ "channelWiseCount" : {
3352
+ "type" : [ "null", "object" ],
3353
+ "additionalProperties" : false,
3354
+ "patternProperties" : {
3355
+ "([0-9]+)" : {
3356
+ "type" : [ "string", "null", "integer" ],
3357
+ "format" : "int64",
3358
+ "pattern" : "([0-9]+)"
3359
+ }
3360
+ }
3361
+ },
3362
+ "escalatedTickets" : {
3363
+ "type" : [ "string", "null", "integer" ],
3364
+ "format" : "int64",
3365
+ "pattern" : "([0-9]+)"
3366
+ },
3367
+ "onholdTickets" : {
3368
+ "type" : [ "string", "null", "integer" ],
3369
+ "format" : "int64",
3370
+ "pattern" : "([0-9]+)"
3371
+ },
3372
+ "overdueTickets" : {
3373
+ "type" : [ "string", "null", "integer" ],
3374
+ "format" : "int64",
3375
+ "pattern" : "([0-9]+)"
3376
+ }
3377
+ },
3378
+ "required" : [ "channelWiseCount", "closedTickets", "customerHappiness", "escalatedTickets", "firstResponseTime", "onholdTickets", "openTickets", "overdueTickets", "resolutionTime", "responseTime", "spamTickets", "totalTickets" ]
3379
+ },
3380
+ "examples" : {
3381
+ "Valid responses Definitions" : {
3382
+ "value" : {
3383
+ "firstResponseTime" : "120000",
3384
+ "openTickets" : "11",
3385
+ "responseTime" : "13150000",
3386
+ "spamTickets" : "0",
3387
+ "totalTickets" : "36",
3388
+ "customerHappiness" : {
3389
+ "badCount" : "50",
3390
+ "goodCount" : "0",
3391
+ "okCount" : "50"
3392
+ },
3393
+ "closedTickets" : "23",
3394
+ "resolutionTime" : "0",
3395
+ "channelWiseCount" : {
3396
+ "Web" : "12",
3397
+ "Forums" : "14",
3398
+ "Chat" : "10"
3399
+ },
3400
+ "onholdTickets" : "2",
3401
+ "escalatedTickets" : "0",
3402
+ "overdueTickets" : "0"
3403
+ }
3404
+ }
3405
+ }
3406
+ }
3407
+ },
3408
+ "x-custom-response-attributes" : {
3409
+ "disable-safe-headers" : "[]"
3410
+ }
3411
+ },
3412
+ "countJson" : {
3413
+ "description" : "countJson template definitions",
3414
+ "content" : {
3415
+ "application/json" : {
3416
+ "schema" : {
3417
+ "type" : [ "null", "object" ],
3418
+ "additionalProperties" : false,
3419
+ "properties" : {
3420
+ "count" : {
3421
+ "type" : [ "string", "null", "integer" ],
3422
+ "format" : "int64",
3423
+ "pattern" : "([0-9]+)"
3424
+ }
3425
+ },
3426
+ "required" : [ "count" ]
3427
+ },
3428
+ "examples" : {
3429
+ "Valid responses Definitions" : {
3430
+ "value" : {
3431
+ "count" : "10"
3432
+ }
3433
+ }
3434
+ }
3435
+ }
3436
+ },
3437
+ "x-custom-response-attributes" : {
3438
+ "disable-safe-headers" : "[]"
3439
+ }
3440
+ },
3441
+ "contactResponse" : {
3442
+ "description" : "contactResponse template definitions",
3443
+ "content" : {
3444
+ "application/json" : {
3445
+ "schema" : {
3446
+ "allOf" : [ {
3447
+ "type" : "object",
3448
+ "properties" : {
3449
+ "owner" : {
3450
+ "type" : [ "null", "object" ],
3451
+ "additionalProperties" : false,
3452
+ "maxProperties" : 3,
3453
+ "minProperties" : 3,
3454
+ "properties" : {
3455
+ "firstName" : {
3456
+ "type" : [ "string", "null" ],
3457
+ "maxLength" : 50,
3458
+ "minLength" : 0
3459
+ },
3460
+ "lastName" : {
3461
+ "type" : [ "string", "null" ],
3462
+ "maxLength" : 50,
3463
+ "minLength" : 0
3464
+ },
3465
+ "id" : {
3466
+ "type" : [ "string", "null", "integer" ],
3467
+ "format" : "int64",
3468
+ "pattern" : "([0-9]+)"
3469
+ }
3470
+ },
3471
+ "required" : [ "firstName", "id", "lastName" ]
3472
+ },
3473
+ "account" : {
3474
+ "type" : [ "null", "object" ],
3475
+ "additionalProperties" : false,
3476
+ "maxProperties" : 3,
3477
+ "minProperties" : 3,
3478
+ "properties" : {
3479
+ "website" : {
3480
+ "type" : [ "string", "null" ],
3481
+ "maxLength" : 120,
3482
+ "minLength" : 0
3483
+ },
3484
+ "accountName" : {
3485
+ "type" : [ "string", "null" ],
3486
+ "maxLength" : 200,
3487
+ "minLength" : 0
3488
+ },
3489
+ "id" : {
3490
+ "type" : [ "string", "null", "integer" ],
3491
+ "format" : "int64",
3492
+ "pattern" : "([0-9]+)"
3493
+ }
3494
+ },
3495
+ "required" : [ "accountName", "id", "website" ]
3496
+ }
3497
+ }
3498
+ }, {
3499
+ "additionalProperties" : false,
3500
+ "allOf" : [ {
3501
+ "$ref" : "./Contact.json#/components/schemas/contactjson"
3502
+ }, {
3503
+ "type" : [ "null", "object" ],
3504
+ "properties" : {
3505
+ "modifiedTime" : {
3506
+ "type" : [ "string", "null" ],
3507
+ "maxLength" : 100,
3508
+ "minLength" : 0,
3509
+ "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))"
3510
+ },
3511
+ "cf" : {
3512
+ "type" : [ "null", "object" ],
3513
+ "additionalProperties" : false,
3514
+ "patternProperties" : {
3515
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
3516
+ "type" : [ "string", "null" ],
3517
+ "maxLength" : 100,
3518
+ "minLength" : 0,
3519
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
3520
+ "x-custom-parameters-attributes" : {
3521
+ "include" : {
3522
+ "removeExif" : false,
3523
+ "filterMatchedContent" : false,
3524
+ "antivirus" : false,
3525
+ "replacementString" : "",
3526
+ "allowInvalid" : false,
3527
+ "descrption" : "Allowed values are : @accounts@ , @owner@",
3528
+ "secret" : false,
3529
+ "preserveCharsLimit" : 10,
3530
+ "split" : ",",
3531
+ "trim" : false,
3532
+ "internalParam" : false,
3533
+ "preserveChars" : "0,5",
3534
+ "importUrl" : false,
3535
+ "decrypt" : false,
3536
+ "entity" : "Include"
3537
+ },
3538
+ "portalname" : {
3539
+ "removeExif" : false,
3540
+ "filterMatchedContent" : false,
3541
+ "antivirus" : false,
3542
+ "replacementString" : "",
3543
+ "trim" : false,
3544
+ "internalParam" : false,
3545
+ "preserveChars" : "0,5",
3546
+ "allowInvalid" : false,
3547
+ "importUrl" : false,
3548
+ "secret" : false,
3549
+ "decrypt" : false,
3550
+ "preserveCharsLimit" : 10
3551
+ },
3552
+ "orgId" : {
3553
+ "removeExif" : false,
3554
+ "filterMatchedContent" : false,
3555
+ "antivirus" : false,
3556
+ "replacementString" : "",
3557
+ "trim" : false,
3558
+ "internalParam" : false,
3559
+ "preserveChars" : "0,5",
3560
+ "allowInvalid" : false,
3561
+ "importUrl" : false,
3562
+ "secret" : false,
3563
+ "decrypt" : false,
3564
+ "preserveCharsLimit" : 10
3565
+ }
3566
+ }
3567
+ }
3568
+ }
3569
+ },
3570
+ "isFollowing" : {
3571
+ "type" : [ "boolean", "null" ]
3572
+ },
3573
+ "accountCount" : {
3574
+ "type" : [ "string", "null", "integer" ],
3575
+ "format" : "int32",
3576
+ "pattern" : "([0-9]+)"
3577
+ },
3578
+ "customFields" : {
3579
+ "type" : [ "null", "object" ],
3580
+ "additionalProperties" : false,
3581
+ "patternProperties" : {
3582
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
3583
+ "type" : [ "string", "null" ],
3584
+ "maxLength" : 100,
3585
+ "minLength" : 0,
3586
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+",
3587
+ "x-custom-parameters-attributes" : {
3588
+ "include" : {
3589
+ "removeExif" : false,
3590
+ "filterMatchedContent" : false,
3591
+ "antivirus" : false,
3592
+ "replacementString" : "",
3593
+ "allowInvalid" : false,
3594
+ "descrption" : "Allowed values are : @accounts@ , @owner@",
3595
+ "secret" : false,
3596
+ "preserveCharsLimit" : 10,
3597
+ "split" : ",",
3598
+ "trim" : false,
3599
+ "internalParam" : false,
3600
+ "preserveChars" : "0,5",
3601
+ "importUrl" : false,
3602
+ "decrypt" : false,
3603
+ "entity" : "Include"
3604
+ },
3605
+ "portalname" : {
3606
+ "removeExif" : false,
3607
+ "filterMatchedContent" : false,
3608
+ "antivirus" : false,
3609
+ "replacementString" : "",
3610
+ "trim" : false,
3611
+ "internalParam" : false,
3612
+ "preserveChars" : "0,5",
3613
+ "allowInvalid" : false,
3614
+ "importUrl" : false,
3615
+ "secret" : false,
3616
+ "decrypt" : false,
3617
+ "preserveCharsLimit" : 10
3618
+ },
3619
+ "orgId" : {
3620
+ "removeExif" : false,
3621
+ "filterMatchedContent" : false,
3622
+ "antivirus" : false,
3623
+ "replacementString" : "",
3624
+ "trim" : false,
3625
+ "internalParam" : false,
3626
+ "preserveChars" : "0,5",
3627
+ "allowInvalid" : false,
3628
+ "importUrl" : false,
3629
+ "secret" : false,
3630
+ "decrypt" : false,
3631
+ "preserveCharsLimit" : 10
3632
+ }
3633
+ }
3634
+ }
3635
+ }
3636
+ },
3637
+ "layoutId" : {
3638
+ "type" : [ "string", "null", "integer" ],
3639
+ "format" : "int64",
3640
+ "pattern" : "([0-9]+)"
3641
+ },
3642
+ "photoURL" : {
3643
+ "type" : [ "string", "null" ],
3644
+ "maxLength" : 100,
3645
+ "minLength" : 0,
3646
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
3647
+ },
3648
+ "isAnonymous" : {
3649
+ "type" : [ "boolean", "null" ]
3650
+ },
3651
+ "isDeleted" : {
3652
+ "type" : [ "boolean", "null" ]
3653
+ },
3654
+ "isTrashed" : {
3655
+ "type" : [ "boolean", "null" ]
3656
+ },
3657
+ "webUrl" : {
3658
+ "type" : [ "string", "null" ],
3659
+ "maxLength" : 500,
3660
+ "minLength" : 0,
3661
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
3662
+ },
3663
+ "createdTime" : {
3664
+ "type" : [ "string", "null" ],
3665
+ "maxLength" : 100,
3666
+ "minLength" : 0,
3667
+ "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))"
3668
+ },
3669
+ "isEndUser" : {
3670
+ "type" : [ "boolean", "null" ]
3671
+ },
3672
+ "zohoCRMContact" : {
3673
+ "$ref" : "./Contact.json#/components/schemas/zohoCRMContact"
3674
+ },
3675
+ "id" : {
3676
+ "type" : [ "string", "null", "integer" ],
3677
+ "format" : "int64",
3678
+ "pattern" : "([0-9]+)"
3679
+ },
3680
+ "customerHappiness" : {
3681
+ "$ref" : "./Contact.json#/components/schemas/customerHappiness"
3682
+ },
3683
+ "isSpam" : {
3684
+ "type" : [ "boolean", "null" ]
3685
+ },
3686
+ "layoutDetails" : {
3687
+ "type" : [ "null", "object" ],
3688
+ "additionalProperties" : false,
3689
+ "maxProperties" : 2,
3690
+ "minProperties" : 2,
3691
+ "properties" : {
3692
+ "id" : {
3693
+ "type" : [ "string", "null", "integer" ],
3694
+ "format" : "int64",
3695
+ "pattern" : "([0-9]+)"
3696
+ },
3697
+ "layoutName" : {
3698
+ "type" : [ "string", "null" ],
3699
+ "maxLength" : 120,
3700
+ "minLength" : 0,
3701
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
3702
+ }
3703
+ },
3704
+ "required" : [ "id", "layoutName" ]
3705
+ }
3706
+ },
3707
+ "required" : [ "accountCount", "cf", "createdTime", "customFields", "customerHappiness", "id", "isAnonymous", "isDeleted", "isEndUser", "isFollowing", "isSpam", "isTrashed", "layoutDetails", "layoutId", "modifiedTime", "photoURL", "webUrl", "zohoCRMContact" ]
3708
+ } ]
3709
+ } ]
3710
+ },
3711
+ "examples" : {
3712
+ "Valid responses Definitions" : {
3713
+ "value" : {
3714
+ "lastName" : "Lawrence",
3715
+ "modifiedTime" : 1462355837000,
3716
+ "country" : null,
3717
+ "secondaryEmail" : null,
3718
+ "city" : null,
3719
+ "description" : null,
3720
+ "ownerId" : "1892000000042001",
3721
+ "type" : null,
3722
+ "title" : null,
3723
+ "photoURL" : "https://desk.zoho.com/api/v1/contacts/1892000000042032/photo",
3724
+ "twitter" : null,
3725
+ "isDeleted" : false,
3726
+ "isTrashed" : false,
3727
+ "street" : null,
3728
+ "createdTime" : 1383564067000,
3729
+ "zohoCRMContact" : {
3730
+ "id" : "5000000014010",
3731
+ "type" : "contacts_leads"
3732
+ },
3733
+ "customerHappiness" : {
3734
+ "badPercentage" : "22",
3735
+ "okPercentage" : "31",
3736
+ "goodPercentage" : "47"
3737
+ },
3738
+ "state" : null,
3739
+ "id" : "1892000000042032",
3740
+ "email" : "lawrence@zylker.com",
3741
+ "zip" : null,
3742
+ "owner" : {
3743
+ "firstName" : "Twin",
3744
+ "lastName" : "john",
3745
+ "id" : "1892000000042001"
3746
+ },
3747
+ "cf" : {
3748
+ "cf_permanentaddress" : null,
3749
+ "cf_lastcontactedon" : null
3750
+ },
3751
+ "isFollowing" : "true",
3752
+ "facebook" : null,
3753
+ "mobile" : null,
3754
+ "accountId" : "1892000000975382",
3755
+ "firstName" : "Jennifer",
3756
+ "isAnonymous" : false,
3757
+ "phone" : "1 888 900 9646",
3758
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
3759
+ "isSpam" : false
3760
+ }
3761
+ }
3762
+ }
3763
+ }
3764
+ },
3765
+ "x-custom-response-attributes" : {
3766
+ "disable-safe-headers" : "[]"
3767
+ }
3768
+ },
3769
+ "contactListViewArrayWithMappingInfo" : {
3770
+ "description" : "contactListViewArrayWithMappingInfo template definitions",
3771
+ "content" : {
3772
+ "application/json" : {
3773
+ "schema" : {
3774
+ "type" : [ "null", "object" ],
3775
+ "additionalProperties" : false,
3776
+ "properties" : {
3777
+ "data" : {
3778
+ "$ref" : "./Contact.json#/components/schemas/dataWithMappingInfo"
3779
+ }
3780
+ },
3781
+ "required" : [ "data" ]
3782
+ },
3783
+ "examples" : {
3784
+ "Valid responses Definitions" : {
3785
+ "value" : {
3786
+ "data" : [ {
3787
+ "lastName" : "Lawrence",
3788
+ "secondaryEmail" : null,
3789
+ "mappingInfo" : {
3790
+ "mappingId" : "18026000003237019",
3791
+ "mappingType" : "PRIMARY",
3792
+ "isAccountTicketsViewable" : true
3793
+ },
3794
+ "mobile" : "+91 8508569683",
3795
+ "type" : null,
3796
+ "ownerId" : "4000000008734",
3797
+ "firstName" : null,
3798
+ "accountId" : "4000000008784",
3799
+ "photoURL" : null,
3800
+ "isAnonymous" : true,
3801
+ "phone" : "1 888 900 9646",
3802
+ "webUrl" : "https://desk.zoho.com/support/zylker/ShowHomePage.do#Contacts/dv/d126330fb061247d9ebddaeb9d93ba74750b0284bc703b38",
3803
+ "createdTime" : 1507813910000,
3804
+ "isEndUser" : "false",
3805
+ "zohoCRMContact" : {
3806
+ "id" : "5000000014010",
3807
+ "type" : "contacts_leads"
3808
+ },
3809
+ "customerHappiness" : {
3810
+ "badPercentage" : "0",
3811
+ "okPercentage" : "0",
3812
+ "goodPercentage" : "0"
3813
+ },
3814
+ "id" : "4000000008786",
3815
+ "isSpam" : false,
3816
+ "email" : "support@zylker.com"
3817
+ } ]
3818
+ }
3819
+ }
3820
+ }
3821
+ }
3822
+ },
3823
+ "x-custom-response-attributes" : {
3824
+ "disable-safe-headers" : "[]"
3825
+ }
3826
+ }
3827
+ },
3828
+ "parameters" : {
3829
+ "accountId" : {
3830
+ "name" : "accountId",
3831
+ "in" : "path",
3832
+ "required" : true,
3833
+ "style" : "simple",
3834
+ "explode" : false,
3835
+ "schema" : {
3836
+ "type" : [ "string", "null", "integer" ],
3837
+ "format" : "int64",
3838
+ "pattern" : "([0-9]+)"
3839
+ }
3840
+ },
3841
+ "viewId" : {
3842
+ "name" : "viewId",
3843
+ "in" : "query",
3844
+ "required" : false,
3845
+ "style" : "form",
3846
+ "explode" : true,
3847
+ "schema" : {
3848
+ "type" : [ "string", "null", "integer" ],
3849
+ "format" : "int64",
3850
+ "pattern" : "([0-9]+)"
3851
+ }
3852
+ },
3853
+ "contactId" : {
3854
+ "name" : "contactId",
3855
+ "in" : "path",
3856
+ "required" : true,
3857
+ "style" : "simple",
3858
+ "explode" : false,
3859
+ "schema" : {
3860
+ "type" : [ "string", "null", "integer" ],
3861
+ "format" : "int64",
3862
+ "pattern" : "([0-9]+)"
3863
+ }
3864
+ },
3865
+ "limit" : {
3866
+ "name" : "limit",
3867
+ "in" : "query",
3868
+ "description" : "Number of contacts to fetch",
3869
+ "required" : false,
3870
+ "style" : "form",
3871
+ "explode" : true,
3872
+ "schema" : {
3873
+ "type" : [ "string", "null", "integer" ],
3874
+ "format" : "int32",
3875
+ "description" : "Number of contacts to fetch",
3876
+ "maximum" : 99,
3877
+ "minimum" : 1,
3878
+ "pattern" : "([0-9]+)"
3879
+ }
3880
+ },
3881
+ "from" : {
3882
+ "name" : "from",
3883
+ "in" : "query",
3884
+ "description" : "Index number, starting from which the contacts must be listed",
3885
+ "required" : false,
3886
+ "style" : "form",
3887
+ "explode" : true,
3888
+ "schema" : {
3889
+ "type" : [ "string", "null", "integer" ],
3890
+ "format" : "int32",
3891
+ "description" : "Index number, starting from which the contacts must be listed",
3892
+ "pattern" : "([0-9]+)"
3893
+ }
3894
+ },
3895
+ "isSpam" : {
3896
+ "name" : "isSpam",
3897
+ "in" : "query",
3898
+ "description" : "Filters Spam contacts",
3899
+ "required" : false,
3900
+ "style" : "form",
3901
+ "explode" : true,
3902
+ "schema" : {
3903
+ "type" : [ "boolean", "null" ],
3904
+ "description" : "Filters Spam contacts"
3905
+ }
3906
+ }
3907
+ },
3908
+ "requestBodies" : {
3909
+ "inviteContactsAsEndUser" : {
3910
+ "content" : {
3911
+ "application/json" : {
3912
+ "schema" : {
3913
+ "type" : [ "null", "object" ],
3914
+ "additionalProperties" : false,
3915
+ "properties" : {
3916
+ "helpCenterId" : {
3917
+ "type" : [ "string", "null", "integer" ],
3918
+ "format" : "int64",
3919
+ "pattern" : "([0-9]+)"
3920
+ },
3921
+ "contactIds" : {
3922
+ "$ref" : "./Contact.json#/components/schemas/long_array"
3923
+ }
3924
+ },
3925
+ "required" : [ "contactIds", "helpCenterId" ]
3926
+ },
3927
+ "examples" : {
3928
+ "Valid requestBody Definitions" : {
3929
+ "value" : {
3930
+ "helpCenterId" : "4000000021302",
3931
+ "contactIds" : [ "4000000012902", "40000000212902", "40000002129122" ]
3932
+ }
3933
+ }
3934
+ }
3935
+ }
3936
+ },
3937
+ "x-custom-request-body-attributes" : {
3938
+ "non-empty" : false,
3939
+ "allow-invalid" : false
3940
+ }
3941
+ },
3942
+ "dissociateAccountsWithContact" : {
3943
+ "content" : {
3944
+ "application/json" : {
3945
+ "schema" : {
3946
+ "type" : [ "null", "object" ],
3947
+ "additionalProperties" : false,
3948
+ "properties" : {
3949
+ "ids" : {
3950
+ "type" : [ "null", "array" ],
3951
+ "items" : {
3952
+ "type" : [ "string", "null", "integer" ],
3953
+ "format" : "int64",
3954
+ "pattern" : "([0-9]+)",
3955
+ "x-custom-parameters-attributes" : [ { } ]
3956
+ },
3957
+ "uniqueItems" : false
3958
+ }
3959
+ },
3960
+ "required" : [ "ids" ]
3961
+ },
3962
+ "examples" : {
3963
+ "Valid requestBody Definitions" : {
3964
+ "value" : {
3965
+ "ids" : [ "7000000027223", "7000000043968" ]
3966
+ }
3967
+ }
3968
+ }
3969
+ }
3970
+ },
3971
+ "x-custom-request-body-attributes" : {
3972
+ "non-empty" : false,
3973
+ "allow-invalid" : false
3974
+ }
3975
+ },
3976
+ "deleteContactsRequest" : {
3977
+ "content" : {
3978
+ "application/json" : {
3979
+ "schema" : {
3980
+ "type" : [ "null", "object" ],
3981
+ "additionalProperties" : false,
3982
+ "properties" : {
3983
+ "contactIds" : {
3984
+ "type" : [ "null", "array" ],
3985
+ "items" : {
3986
+ "type" : [ "string", "null", "integer" ],
3987
+ "format" : "int64",
3988
+ "pattern" : "([0-9]+)",
3989
+ "x-custom-parameters-attributes" : [ { } ]
3990
+ },
3991
+ "uniqueItems" : false
3992
+ }
3993
+ },
3994
+ "required" : [ "contactIds" ]
3995
+ },
3996
+ "examples" : {
3997
+ "Valid requestBody Definitions" : {
3998
+ "value" : {
3999
+ "contactIds" : [ "2000032002145" ]
4000
+ }
4001
+ }
4002
+ }
4003
+ }
4004
+ },
4005
+ "x-custom-request-body-attributes" : {
4006
+ "non-empty" : false,
4007
+ "allow-invalid" : false
4008
+ }
4009
+ },
4010
+ "contact_massupdate" : {
4011
+ "content" : {
4012
+ "application/json" : {
4013
+ "schema" : {
4014
+ "type" : [ "null", "object" ],
4015
+ "additionalProperties" : false,
4016
+ "properties" : {
4017
+ "isCustomField" : {
4018
+ "type" : [ "boolean", "null" ]
4019
+ },
4020
+ "fieldName" : {
4021
+ "type" : [ "string", "null" ],
4022
+ "maxLength" : 100,
4023
+ "minLength" : 0,
4024
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
4025
+ },
4026
+ "ids" : {
4027
+ "$ref" : "./Contact.json#/components/schemas/long_array"
4028
+ },
4029
+ "fieldValue" : {
4030
+ "type" : [ "string", "null" ],
4031
+ "maxLength" : 100,
4032
+ "minLength" : 0,
4033
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
4034
+ }
4035
+ },
4036
+ "required" : [ "fieldName", "ids" ]
4037
+ },
4038
+ "examples" : {
4039
+ "Valid requestBody Definitions" : {
4040
+ "value" : {
4041
+ "fieldName" : "mobile",
4042
+ "isCustomField" : false,
4043
+ "ids" : [ "1892000000093303", "1892000000085009", "1892000000050003" ],
4044
+ "fieldValue" : "8508569875"
4045
+ }
4046
+ }
4047
+ }
4048
+ }
4049
+ },
4050
+ "x-custom-request-body-attributes" : {
4051
+ "non-empty" : false,
4052
+ "allow-invalid" : false
4053
+ }
4054
+ },
4055
+ "contactjson" : {
4056
+ "content" : {
4057
+ "application/json" : {
4058
+ "schema" : {
4059
+ "additionalProperties" : false,
4060
+ "allOf" : [ {
4061
+ "$ref" : "./Contact.json#/components/schemas/commonJson"
4062
+ }, {
4063
+ "type" : [ "null", "object" ],
4064
+ "properties" : {
4065
+ "zip" : {
4066
+ "type" : [ "string", "null", "integer" ],
4067
+ "format" : "int32",
4068
+ "description" : "Zip code",
4069
+ "pattern" : "([0-9]+)"
4070
+ },
4071
+ "country" : {
4072
+ "type" : [ "string", "null" ],
4073
+ "description" : "Contact's country of residence",
4074
+ "maxLength" : 30,
4075
+ "minLength" : 0
4076
+ },
4077
+ "twitter" : {
4078
+ "type" : [ "string", "null" ],
4079
+ "description" : "Twitter ID of the contact",
4080
+ "maxLength" : 100,
4081
+ "minLength" : 0,
4082
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
4083
+ },
4084
+ "cf" : {
4085
+ "type" : [ "null", "object" ],
4086
+ "additionalProperties" : false,
4087
+ "patternProperties" : {
4088
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
4089
+ "type" : [ "string", "null" ],
4090
+ "maxLength" : 100,
4091
+ "minLength" : 0,
4092
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
4093
+ }
4094
+ }
4095
+ },
4096
+ "city" : {
4097
+ "type" : [ "string", "null" ],
4098
+ "description" : "Contact's city of residence",
4099
+ "maxLength" : 30,
4100
+ "minLength" : 0
4101
+ },
4102
+ "customFields" : {
4103
+ "type" : [ "null", "object" ],
4104
+ "additionalProperties" : false,
4105
+ "patternProperties" : {
4106
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
4107
+ "type" : [ "string", "null" ],
4108
+ "maxLength" : 100,
4109
+ "minLength" : 0,
4110
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
4111
+ }
4112
+ }
4113
+ },
4114
+ "street" : {
4115
+ "type" : [ "string", "null" ],
4116
+ "description" : "Contact's address",
4117
+ "maxLength" : 250,
4118
+ "minLength" : 0
4119
+ },
4120
+ "facebook" : {
4121
+ "type" : [ "string", "null" ],
4122
+ "description" : "Facebook ID of the contact",
4123
+ "maxLength" : 100,
4124
+ "minLength" : 0,
4125
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
4126
+ },
4127
+ "mobile" : {
4128
+ "type" : [ "string", "null" ],
4129
+ "description" : "Mobile number of the contact",
4130
+ "maxLength" : 50,
4131
+ "minLength" : 0,
4132
+ "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
4133
+ "x-custom-parameters-attributes" : {
4134
+ "filterMatchedContent" : true,
4135
+ "replacementString" : ""
4136
+ }
4137
+ },
4138
+ "description" : {
4139
+ "type" : [ "string", "null" ],
4140
+ "description" : "Contact description",
4141
+ "maxLength" : 65535,
4142
+ "minLength" : 0
4143
+ },
4144
+ "state" : {
4145
+ "type" : [ "string", "null" ],
4146
+ "description" : "Contact's state of residence",
4147
+ "maxLength" : 30,
4148
+ "minLength" : 0
4149
+ },
4150
+ "title" : {
4151
+ "type" : [ "string", "null" ],
4152
+ "description" : "Contact title",
4153
+ "maxLength" : 100,
4154
+ "minLength" : 0
4155
+ }
4156
+ }
4157
+ }, {
4158
+ "type" : "object",
4159
+ "required" : [ "lastName" ]
4160
+ } ]
4161
+ },
4162
+ "examples" : {
4163
+ "Valid requestBody Definitions" : {
4164
+ "value" : {
4165
+ "zip" : "123902",
4166
+ "lastName" : "Jack",
4167
+ "country" : "USA",
4168
+ "secondaryEmail" : "hughjack@zylker.com",
4169
+ "city" : "Texas",
4170
+ "facebook" : "hugh jacks",
4171
+ "mobile" : "+10 2328829010",
4172
+ "description" : "first priority contact",
4173
+ "ownerId" : "1892000000056007",
4174
+ "type" : "paidUser",
4175
+ "title" : "The contact",
4176
+ "accountId" : "1892000000052077",
4177
+ "firstName" : "hugh",
4178
+ "twitter" : "Hugh jack",
4179
+ "phone" : "91020080878",
4180
+ "street" : "North street",
4181
+ "state" : "Austin",
4182
+ "email" : "jack@zylker.com"
4183
+ }
4184
+ }
4185
+ }
4186
+ }
4187
+ },
4188
+ "x-custom-request-body-attributes" : {
4189
+ "non-empty" : false,
4190
+ "allow-invalid" : false
4191
+ }
4192
+ },
4193
+ "updateContact_contactjson" : {
4194
+ "content" : {
4195
+ "application/json" : {
4196
+ "schema" : {
4197
+ "additionalProperties" : false,
4198
+ "allOf" : [ {
4199
+ "$ref" : "./Contact.json#/components/schemas/commonJson"
4200
+ }, {
4201
+ "type" : [ "null", "object" ],
4202
+ "properties" : {
4203
+ "zip" : {
4204
+ "type" : [ "string", "null", "integer" ],
4205
+ "format" : "int32",
4206
+ "description" : "Zip code",
4207
+ "pattern" : "([0-9]+)"
4208
+ },
4209
+ "country" : {
4210
+ "type" : [ "string", "null" ],
4211
+ "description" : "Contact's country of residence",
4212
+ "maxLength" : 30,
4213
+ "minLength" : 0
4214
+ },
4215
+ "twitter" : {
4216
+ "type" : [ "string", "null" ],
4217
+ "description" : "Twitter ID of the contact",
4218
+ "maxLength" : 100,
4219
+ "minLength" : 0,
4220
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
4221
+ },
4222
+ "cf" : {
4223
+ "type" : [ "null", "object" ],
4224
+ "additionalProperties" : false,
4225
+ "patternProperties" : {
4226
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
4227
+ "type" : [ "string", "null" ],
4228
+ "maxLength" : 100,
4229
+ "minLength" : 0,
4230
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
4231
+ }
4232
+ }
4233
+ },
4234
+ "city" : {
4235
+ "type" : [ "string", "null" ],
4236
+ "description" : "Contact's city of residence",
4237
+ "maxLength" : 30,
4238
+ "minLength" : 0
4239
+ },
4240
+ "customFields" : {
4241
+ "type" : [ "null", "object" ],
4242
+ "additionalProperties" : false,
4243
+ "patternProperties" : {
4244
+ "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+" : {
4245
+ "type" : [ "string", "null" ],
4246
+ "maxLength" : 100,
4247
+ "minLength" : 0,
4248
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
4249
+ }
4250
+ }
4251
+ },
4252
+ "street" : {
4253
+ "type" : [ "string", "null" ],
4254
+ "description" : "Contact's address",
4255
+ "maxLength" : 250,
4256
+ "minLength" : 0
4257
+ },
4258
+ "facebook" : {
4259
+ "type" : [ "string", "null" ],
4260
+ "description" : "Facebook ID of the contact",
4261
+ "maxLength" : 100,
4262
+ "minLength" : 0,
4263
+ "pattern" : "(^(ht|f)tp(s?)\\://[-.\\w]*(/?)([a-zA-Z0-9\\-\\.\\?\\,\\:\\'/\\\\+=&amp;%\\$#_@]*)?$)"
4264
+ },
4265
+ "mobile" : {
4266
+ "type" : [ "string", "null" ],
4267
+ "description" : "Mobile number of the contact",
4268
+ "maxLength" : 50,
4269
+ "minLength" : 0,
4270
+ "pattern" : "[0-9a-zA-Z_\\+\\-\\.\\(\\)\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s]+",
4271
+ "x-custom-parameters-attributes" : {
4272
+ "filterMatchedContent" : true,
4273
+ "replacementString" : ""
4274
+ }
4275
+ },
4276
+ "description" : {
4277
+ "type" : [ "string", "null" ],
4278
+ "description" : "Contact description",
4279
+ "maxLength" : 65535,
4280
+ "minLength" : 0
4281
+ },
4282
+ "state" : {
4283
+ "type" : [ "string", "null" ],
4284
+ "description" : "Contact's state of residence",
4285
+ "maxLength" : 30,
4286
+ "minLength" : 0
4287
+ },
4288
+ "title" : {
4289
+ "type" : [ "string", "null" ],
4290
+ "description" : "Contact title",
4291
+ "maxLength" : 100,
4292
+ "minLength" : 0
4293
+ }
4294
+ }
4295
+ }, {
4296
+ "type" : "object"
4297
+ } ]
4298
+ },
4299
+ "examples" : {
4300
+ "Valid requestBody Definitions" : {
4301
+ "value" : null
4302
+ }
4303
+ }
4304
+ }
4305
+ },
4306
+ "x-custom-request-body-attributes" : {
4307
+ "non-empty" : false,
4308
+ "allow-invalid" : false
4309
+ }
4310
+ },
4311
+ "contactMergeRequest" : {
4312
+ "content" : {
4313
+ "application/json" : {
4314
+ "schema" : {
4315
+ "type" : [ "null", "object" ],
4316
+ "additionalProperties" : false,
4317
+ "properties" : {
4318
+ "ids" : {
4319
+ "$ref" : "./Contact.json#/components/schemas/long_array"
4320
+ },
4321
+ "source" : {
4322
+ "$ref" : "./Contact.json#/components/schemas/sourceValues"
4323
+ }
4324
+ },
4325
+ "required" : [ "ids" ]
4326
+ },
4327
+ "examples" : {
4328
+ "Valid requestBody Definitions" : {
4329
+ "value" : {
4330
+ "ids" : [ "4000000018011", "4000000018021" ],
4331
+ "source" : {
4332
+ "zip" : "4000000018011",
4333
+ "lastName" : "4000000018011",
4334
+ "country" : "4000000018011",
4335
+ "secondaryEmail" : "4000000018011",
4336
+ "cf" : {
4337
+ "cf_permanentaddress" : 1892220000042001
4338
+ },
4339
+ "city" : "4000000018011",
4340
+ "facebook" : "4000000018011",
4341
+ "mobile" : "4000000018011",
4342
+ "description" : "4000000018011",
4343
+ "type" : "4000000018011",
4344
+ "title" : "4000000018011",
4345
+ "firstName" : "4000000018011",
4346
+ "accountId" : "4000000018011",
4347
+ "twitter" : "4000000018011",
4348
+ "phone" : "4000000018011",
4349
+ "street" : "4000000018011",
4350
+ "email" : "4000000018011"
4351
+ }
4352
+ }
4353
+ }
4354
+ }
4355
+ }
4356
+ },
4357
+ "x-custom-request-body-attributes" : {
4358
+ "non-empty" : false,
4359
+ "allow-invalid" : false
4360
+ }
4361
+ },
4362
+ "updateSignupApproval" : {
4363
+ "content" : {
4364
+ "application/json" : {
4365
+ "schema" : {
4366
+ "type" : [ "null", "object" ],
4367
+ "additionalProperties" : false,
4368
+ "properties" : {
4369
+ "helpCenterIds" : {
4370
+ "type" : [ "null", "array" ],
4371
+ "items" : {
4372
+ "type" : [ "string", "null", "integer" ],
4373
+ "format" : "int64",
4374
+ "pattern" : "([0-9]+)",
4375
+ "x-custom-parameters-attributes" : [ { } ]
4376
+ },
4377
+ "uniqueItems" : false
4378
+ }
4379
+ },
4380
+ "required" : [ "helpCenterIds" ]
4381
+ },
4382
+ "examples" : {
4383
+ "Valid requestBody Definitions" : {
4384
+ "value" : {
4385
+ "helpCenterIds" : [ "4000000021302" ]
4386
+ }
4387
+ }
4388
+ }
4389
+ }
4390
+ },
4391
+ "x-custom-request-body-attributes" : {
4392
+ "non-empty" : false,
4393
+ "allow-invalid" : false
4394
+ }
4395
+ },
4396
+ "rejectEndUserInvite_updateSignupApproval" : {
4397
+ "content" : {
4398
+ "application/json" : {
4399
+ "schema" : {
4400
+ "type" : [ "null", "object" ],
4401
+ "additionalProperties" : false,
4402
+ "properties" : {
4403
+ "helpCenterIds" : {
4404
+ "type" : [ "null", "array" ],
4405
+ "items" : {
4406
+ "type" : [ "string", "null", "integer" ],
4407
+ "format" : "int64",
4408
+ "pattern" : "([0-9]+)",
4409
+ "x-custom-parameters-attributes" : [ { } ]
4410
+ },
4411
+ "uniqueItems" : false
4412
+ }
4413
+ },
4414
+ "required" : [ "helpCenterIds" ]
4415
+ },
4416
+ "examples" : {
4417
+ "Valid requestBody Definitions" : {
4418
+ "value" : {
4419
+ "helpCenterIds" : [ "4000000021302" ]
4420
+ }
4421
+ }
4422
+ }
4423
+ }
4424
+ },
4425
+ "x-custom-request-body-attributes" : {
4426
+ "non-empty" : false,
4427
+ "allow-invalid" : false
4428
+ }
4429
+ },
4430
+ "associateAccountsWithContact" : {
4431
+ "content" : {
4432
+ "application/json" : {
4433
+ "schema" : {
4434
+ "type" : [ "null", "object" ],
4435
+ "additionalProperties" : false,
4436
+ "properties" : {
4437
+ "data" : {
4438
+ "type" : [ "null", "array" ],
4439
+ "items" : {
4440
+ "type" : [ "null", "object" ],
4441
+ "additionalProperties" : false,
4442
+ "maxProperties" : 2,
4443
+ "minProperties" : 2,
4444
+ "properties" : {
4445
+ "id" : {
4446
+ "type" : [ "string", "null", "integer" ],
4447
+ "format" : "int64",
4448
+ "pattern" : "([0-9]+)",
4449
+ "x-custom-parameters-attributes" : [ ]
4450
+ },
4451
+ "isAccountTicketsViewable" : {
4452
+ "type" : [ "boolean", "null" ],
4453
+ "x-custom-parameters-attributes" : [ ]
4454
+ }
4455
+ },
4456
+ "required" : [ "id", "isAccountTicketsViewable" ],
4457
+ "x-custom-parameters-attributes" : [ ]
4458
+ },
4459
+ "uniqueItems" : false
4460
+ }
4461
+ },
4462
+ "required" : [ "data" ]
4463
+ },
4464
+ "examples" : {
4465
+ "Valid requestBody Definitions" : {
4466
+ "value" : {
4467
+ "data" : [ {
4468
+ "id" : 7000000027223,
4469
+ "isAccountTicketsViewable" : true
4470
+ }, {
4471
+ "id" : 7000000043968,
4472
+ "isAccountTicketsViewable" : false
4473
+ } ]
4474
+ }
4475
+ }
4476
+ }
4477
+ }
4478
+ },
4479
+ "x-custom-request-body-attributes" : {
4480
+ "non-empty" : false,
4481
+ "allow-invalid" : false
4482
+ }
4483
+ },
4484
+ "associateProductsWithContact" : {
4485
+ "content" : {
4486
+ "application/json" : {
4487
+ "schema" : {
4488
+ "type" : [ "null", "object" ],
4489
+ "additionalProperties" : false,
4490
+ "properties" : {
4491
+ "departmentId" : {
4492
+ "type" : [ "string", "null", "integer" ],
4493
+ "format" : "int64",
4494
+ "pattern" : "([0-9]+)",
4495
+ "x-custom-parameters-attributes" : {
4496
+ "entity" : "Departments"
4497
+ }
4498
+ },
4499
+ "ids" : {
4500
+ "type" : [ "null", "array" ],
4501
+ "items" : {
4502
+ "type" : [ "string", "null", "integer" ],
4503
+ "format" : "int64",
4504
+ "pattern" : "([0-9]+)",
4505
+ "x-custom-parameters-attributes" : [ { } ]
4506
+ },
4507
+ "uniqueItems" : false
4508
+ },
4509
+ "associate" : {
4510
+ "type" : [ "boolean", "null" ]
4511
+ }
4512
+ },
4513
+ "required" : [ "associate", "ids" ]
4514
+ },
4515
+ "examples" : {
4516
+ "Valid requestBody Definitions" : {
4517
+ "value" : {
4518
+ "departmentId" : "7000000062800",
4519
+ "ids" : [ "7000000027223", "7000000043968" ],
4520
+ "associate" : true
4521
+ }
4522
+ }
4523
+ }
4524
+ }
4525
+ },
4526
+ "x-custom-request-body-attributes" : {
4527
+ "non-empty" : false,
4528
+ "allow-invalid" : false
4529
+ }
4530
+ },
4531
+ "deleteSpamContacts_deleteContactsRequest" : {
4532
+ "content" : {
4533
+ "application/json" : {
4534
+ "schema" : {
4535
+ "type" : [ "null", "object" ],
4536
+ "additionalProperties" : false,
4537
+ "properties" : {
4538
+ "contactIds" : {
4539
+ "type" : [ "null", "array" ],
4540
+ "items" : {
4541
+ "type" : [ "string", "null", "integer" ],
4542
+ "format" : "int64",
4543
+ "pattern" : "([0-9]+)",
4544
+ "x-custom-parameters-attributes" : [ { } ]
4545
+ },
4546
+ "uniqueItems" : false
4547
+ }
4548
+ },
4549
+ "required" : [ "contactIds" ]
4550
+ },
4551
+ "examples" : {
4552
+ "Valid requestBody Definitions" : {
4553
+ "value" : {
4554
+ "contactIds" : [ "1892000000004507", "1892000000004508" ]
4555
+ }
4556
+ }
4557
+ }
4558
+ }
4559
+ },
4560
+ "x-custom-request-body-attributes" : {
4561
+ "non-empty" : false,
4562
+ "allow-invalid" : false
4563
+ }
4564
+ },
4565
+ "inviteContactAsEndUser" : {
4566
+ "content" : {
4567
+ "application/json" : {
4568
+ "schema" : {
4569
+ "type" : [ "null", "object" ],
4570
+ "additionalProperties" : false,
4571
+ "properties" : {
4572
+ "helpCenterId" : {
4573
+ "type" : [ "string", "null", "integer" ],
4574
+ "format" : "int64",
4575
+ "pattern" : "([0-9]+)"
4576
+ }
4577
+ },
4578
+ "required" : [ "helpCenterId" ]
4579
+ },
4580
+ "examples" : {
4581
+ "Valid requestBody Definitions" : {
4582
+ "value" : {
4583
+ "helpCenterId" : "4000000021302"
4584
+ }
4585
+ }
4586
+ }
4587
+ }
4588
+ },
4589
+ "x-custom-request-body-attributes" : {
4590
+ "non-empty" : false,
4591
+ "allow-invalid" : false
4592
+ }
4593
+ },
4594
+ "invitePortalUserJson" : {
4595
+ "content" : {
4596
+ "application/json" : {
4597
+ "schema" : {
4598
+ "type" : [ "null", "object" ],
4599
+ "additionalProperties" : false,
4600
+ "properties" : {
4601
+ "emailIds" : {
4602
+ "type" : [ "null", "array" ],
4603
+ "items" : {
4604
+ "type" : [ "string", "null" ],
4605
+ "maxLength" : 255,
4606
+ "minLength" : 0,
4607
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'\\&\\~]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$",
4608
+ "x-custom-parameters-attributes" : [ { } ]
4609
+ },
4610
+ "uniqueItems" : false
4611
+ },
4612
+ "departmentId" : {
4613
+ "type" : [ "string", "null", "integer" ],
4614
+ "format" : "int64",
4615
+ "pattern" : "([0-9]+)",
4616
+ "x-custom-parameters-attributes" : {
4617
+ "entity" : "Departments"
4618
+ }
4619
+ }
4620
+ },
4621
+ "required" : [ "emailIds" ]
4622
+ },
4623
+ "examples" : {
4624
+ "Valid requestBody Definitions" : {
4625
+ "value" : null
4626
+ }
4627
+ }
4628
+ }
4629
+ },
4630
+ "x-custom-request-body-attributes" : {
4631
+ "non-empty" : false,
4632
+ "allow-invalid" : false
4633
+ }
4634
+ },
4635
+ "markSpamContactPayload" : {
4636
+ "content" : {
4637
+ "application/json" : {
4638
+ "schema" : {
4639
+ "type" : "object",
4640
+ "properties" : {
4641
+ "ids" : {
4642
+ "type" : "array",
4643
+ "description" : "ID(s) of the contact(s) that must be marked or unmarked as spam",
4644
+ "items" : {
4645
+ "type" : [ "string", "integer" ],
4646
+ "format" : "int64",
4647
+ "pattern" : "([0-9]+)"
4648
+ }
4649
+ },
4650
+ "isSpam" : {
4651
+ "type" : "boolean",
4652
+ "description" : "Key that marks or unmarks a single contact or multiple contacts as spam"
4653
+ },
4654
+ "handleExistingTickets" : {
4655
+ "type" : "boolean",
4656
+ "description" : "Key that marks or unmarks tickets from the contact(s) as spam"
4657
+ }
4658
+ },
4659
+ "required" : [ "ids", "isSpam" ]
4660
+ },
4661
+ "examples" : {
4662
+ "Valid requestBody Definitions" : {
4663
+ "value" : {
4664
+ "handleExistingTickets" : "true",
4665
+ "ids" : [ "1000000030065", "1000000030068" ],
4666
+ "isSpam" : "true"
4667
+ }
4668
+ }
4669
+ }
4670
+ }
4671
+ },
4672
+ "x-custom-request-body-attributes" : {
4673
+ "non-empty" : false,
4674
+ "allow-invalid" : false
4675
+ }
4676
+ }
4677
+ },
4678
+ "securitySchemes" : {
4679
+ "cookie-auth" : {
4680
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
4681
+ },
4682
+ "org-oauth" : {
4683
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
4684
+ },
4685
+ "iam-oauth2-schema" : {
4686
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
4687
+ }
4688
+ }
4689
+ },
4690
+ "x-entity" : "Contact"
4691
+ }