{"openapi":"3.0.0","info":{"description":"Zoho CRM v6 REST API — verified 2026-09-01: OAuth 2.0 via Zoho Accounts (Authorization: Zoho-oauthtoken), base https://www.zohoapis.com/crm/v6 per DC (www.zohoapis.com/.eu/.in/.com.au/.jp). Covers records CRUD, search, COQL, bulk read, notifications, metadata (modules/fields/layouts/custom views), users/roles/profiles, notes, attachments, territories, pipelines, variables, lead conversion and ZFS file uploads. Evidence: evidence/html/ (52 pages), evidence/auth-probe.txt."},"servers":[{"description":"Zoho CRM v6 REST API — verified 2026-09-01: OAuth 2.0 via Zoho Accounts (Authorization: Zoho-oauthtoken), base https://www.zohoapis.com/crm/v6 per DC (www.zohoapis.com/.eu/.in/.com.au/.jp). Covers records CRUD, search, COQL, bulk read, notifications, metadata (modules/fields/layouts/custom views), users/roles/profiles, notes, attachments, territories, pipelines, variables, lead conversion and ZFS file uploads. Evidence: evidence/html/ (52 pages), evidence/auth-probe.txt.","url":"https://api.apirails.com/zohocrm"}],"paths":{"/crm/v6/coql":{"post":{"tags":["COQL"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/Get-Records-through-COQL-Query.html","api_endpoint":"https://{crm_host}/crm/v6/coql"},"summary":"Get Records through a COQL Query","description":"Get Records through a COQL Query. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.coql.READ).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"select_query":{"type":"string","description":"COQL SELECT query string (e.g. select Last_Name from Leads where Last_Name like '%a%')","required":true}}},"example":{"select_query":""}}}}}},"/crm/bulk/v6/read":{"post":{"tags":["Bulk Read"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/bulk-read__create-job.html","api_endpoint":"https://{crm_host}/crm/bulk/v6/read"},"summary":"Create Bulk Read job (Bulk Export)","description":"Create Bulk Read job (Bulk Export). Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.bulk.read).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback":{"type":"object","description":"Nested object","required":true,"properties":{"method":{"type":"string","description":"String value","required":true},"url":{"type":"string","description":"String value","required":true}}},"file_type":{"type":"string","description":"String value","required":true},"query":{"type":"object","description":"Nested object","required":true,"properties":{"module":{"type":"object","description":"Nested object","required":true}}}}},"example":{"callback":{},"file_type":"","query":{}}}}}}},"/crm/v6/Leads/{record_id}/actions/convert":{"post":{"tags":["Lead Conversion"],"parameters":[{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/convert-lead.html","api_endpoint":"https://{crm_host}/crm/v6/Leads/{record_id}/actions/convert"},"summary":"Convert Lead","description":"Convert Lead. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"array","description":"Array of record objects to process (field API names as keys; use the Fields Metadata API for valid keys)","required":true,"items":{"type":"object","properties":{"Accounts":{"type":"object","description":"Nested object","required":true},"Contacts":{"type":"object","description":"Nested object","required":true},"Deals":{"type":"object","description":"Nested object","required":true},"carry_over_tags":{"type":"object","description":"Nested object","required":true},"move_attachments_to":{"type":"object","description":"Nested object","required":true},"notify_lead_owner":{"type":"boolean","description":"Boolean value","required":true},"notify_new_entity_owner":{"type":"boolean","description":"Boolean value","required":true},"overwrite":{"type":"boolean","description":"Boolean value","required":true}}}}}},"example":{"data":[]}}}}}},"/crm/v6/settings/custom_views":{"get":{"tags":["Metadata"],"parameters":[{"name":"module","in":"query","description":"Specify the API name of the required module.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/custom-view-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/custom_views"},"summary":"Custom Views Metadata","description":"Custom Views Metadata. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.custom_views.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/custom_views/{custom_view_id}":{"get":{"tags":["Metadata"],"parameters":[{"name":"custom_view_id","in":"path","description":"Unique ID of the custom view","required":true,"schema":{"type":"string","example":""}},{"name":"module","in":"query","description":"Specify the API name of the required module.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/custom-view-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/custom_views/{custom_view_id}"},"summary":"Custom Views Metadata ({custom_view_id})","description":"Custom Views Metadata. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.custom_views.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/{module_api_name}":{"delete":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"ids","in":"query","description":"Specify the unique ID of the record that you want to delete.","required":true,"schema":{"type":"string","example":""}},{"name":"wf_trigger","in":"query","description":"Represents if the workflow rules are to be triggered upon record deletion.","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/delete-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}"},"summary":"Delete Records","description":"Delete Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"approval_state","in":"query","description":"To retrieve the list of records based on various approval stages.","required":false,"schema":{"type":"string","example":""}},{"name":"converted","in":"query","description":"To get the list of converted records.","required":false,"schema":{"type":"string","example":""}},{"name":"cvid","in":"query","description":"To get the list of records based on custom views.","required":false,"schema":{"type":"number","example":""}},{"name":"fields","in":"query","description":"To list all the module records with respect to fields.","required":false,"schema":{"type":"string","example":""}},{"name":"ids","in":"query","description":"To retrieve specific records based on their unique ID.","required":false,"schema":{"type":"string","example":""}},{"name":"include_child","in":"query","description":"To include records from the child territories.Default value is false .","required":false,"schema":{"type":"boolean","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"page_token","in":"query","description":"You can use the \"page\" param to fetch up to 2000 records without \"page_token\".","required":true,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}},{"name":"sort_by","in":"query","description":"To sort the records based on the fields id , Created_Time , and Modified_Time .","required":false,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"Specifies the order in which records are sorted, based on the field provided in the sort_by parameter.","required":false,"schema":{"type":"string","example":""}},{"name":"territory_id","in":"query","description":"To get the list of records based on the territory.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}"},"summary":"Get Records","description":"Get Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]},"post":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/insert-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}"},"summary":"Insert Records","description":"Insert Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"apply_feature_execution":{"type":"array","description":"Array value","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"String value","required":true}}}},"data":{"type":"array","description":"Array of record objects to process (field API names as keys; use the Fields Metadata API for valid keys)","required":true,"items":{"type":"object","properties":{"$wizard_connection_path":{"type":"array","description":"Array value","required":true},"Company":{"type":"string","description":"String value","required":true},"Email":{"type":"string","description":"String value","required":true},"First_Name":{"type":"string","description":"String value","required":true},"Last_Name":{"type":"string","description":"String value","required":true},"Layout":{"type":"object","description":"Nested object","required":true},"Lead_Source":{"type":"string","description":"String value","required":true},"State":{"type":"string","description":"String value","required":true},"Wizard":{"type":"object","description":"Nested object","required":true}}}},"skip_feature_execution":{"type":"array","description":"Array value","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"String value","required":true}}}},"trigger":{"type":"array","description":"Automation to trigger: workflow, approval, blueprint, pathfinder or orchestration. [] executes none","required":true,"items":{"type":"string"}}}},"example":{"apply_feature_execution":[],"data":[],"skip_feature_execution":[],"trigger":[]}}}}},"put":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/update-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}"},"summary":"Update Records","description":"Update Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"apply_feature_execution":{"type":"array","description":"Array value","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"String value","required":true}}}},"data":{"type":"array","description":"Array of record objects to process (field API names as keys; use the Fields Metadata API for valid keys)","required":true,"items":{"type":"object","properties":{"$append_values":{"type":"object","description":"Nested object","required":true},"AssociatedUser":{"type":"array","description":"Array value","required":true},"Deal_Name":{"type":"string","description":"String value","required":true},"File_Upload":{"type":"array","description":"Array value","required":true},"Foreign_Languages":{"type":"array","description":"Array value","required":true},"Image_Upload":{"type":"array","description":"Array value","required":true},"Listings":{"type":"array","description":"Array value","required":true},"Pipeline":{"type":"string","description":"String value","required":true},"Stage":{"type":"string","description":"String value","required":true},"id":{"type":"string","description":"String value","required":true}}}},"skip_feature_execution":{"type":"array","description":"Array value","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"String value","required":true}}}}}},"example":{"apply_feature_execution":[],"data":[],"skip_feature_execution":[]}}}}}},"/crm/v6/{module_api_name}/{record_id}":{"delete":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}},{"name":"ids","in":"query","description":"Specify the unique ID of the record that you want to delete.","required":true,"schema":{"type":"string","example":""}},{"name":"wf_trigger","in":"query","description":"Represents if the workflow rules are to be triggered upon record deletion.","required":false,"schema":{"type":"boolean","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/delete-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}"},"summary":"Delete Records ({record_id})","description":"Delete Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}},{"name":"approval_state","in":"query","description":"To retrieve the list of records based on various approval stages.","required":false,"schema":{"type":"string","example":""}},{"name":"converted","in":"query","description":"To get the list of converted records.","required":false,"schema":{"type":"string","example":""}},{"name":"cvid","in":"query","description":"To get the list of records based on custom views.","required":false,"schema":{"type":"number","example":""}},{"name":"fields","in":"query","description":"To list all the module records with respect to fields.","required":false,"schema":{"type":"string","example":""}},{"name":"ids","in":"query","description":"To retrieve specific records based on their unique ID.","required":false,"schema":{"type":"string","example":""}},{"name":"include_child","in":"query","description":"To include records from the child territories.Default value is false .","required":false,"schema":{"type":"boolean","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"page_token","in":"query","description":"You can use the \"page\" param to fetch up to 2000 records without \"page_token\".","required":true,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}},{"name":"sort_by","in":"query","description":"To sort the records based on the fields id , Created_Time , and Modified_Time .","required":false,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"Specifies the order in which records are sorted, based on the field provided in the sort_by parameter.","required":false,"schema":{"type":"string","example":""}},{"name":"territory_id","in":"query","description":"To get the list of records based on the territory.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}"},"summary":"Get Records ({record_id})","description":"Get Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]},"put":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/update-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}"},"summary":"Update Records ({record_id})","description":"Update Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"apply_feature_execution":{"type":"array","description":"Array value","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"String value","required":true}}}},"data":{"type":"array","description":"Array of record objects to process (field API names as keys; use the Fields Metadata API for valid keys)","required":true,"items":{"type":"object","properties":{"$append_values":{"type":"object","description":"Nested object","required":true},"AssociatedUser":{"type":"array","description":"Array value","required":true},"Deal_Name":{"type":"string","description":"String value","required":true},"File_Upload":{"type":"array","description":"Array value","required":true},"Foreign_Languages":{"type":"array","description":"Array value","required":true},"Image_Upload":{"type":"array","description":"Array value","required":true},"Listings":{"type":"array","description":"Array value","required":true},"Pipeline":{"type":"string","description":"String value","required":true},"Stage":{"type":"string","description":"String value","required":true},"id":{"type":"string","description":"String value","required":true}}}},"skip_feature_execution":{"type":"array","description":"Array value","required":true,"items":{"type":"object","properties":{"name":{"type":"string","description":"String value","required":true}}}}}},"example":{"apply_feature_execution":[],"data":[],"skip_feature_execution":[]}}}}}},"/crm/v6/{module_api_name}/{record_id}/Attachments/{attachment_id}":{"get":{"tags":["Attachments"],"parameters":[{"name":"attachment_id","in":"path","description":"Unique ID of the attachment","required":true,"schema":{"type":"string","example":""}},{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/download-attachments.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}/Attachments/{attachment_id}"},"summary":"Download an Attachment","description":"Download an Attachment. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/email_templates":{"get":{"tags":["Templates"],"parameters":[{"name":"module","in":"query","description":"The API name of the module you want to fetch email template from.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/email-templates.html","api_endpoint":"https://{crm_host}/crm/v6/settings/email_templates"},"summary":"Email Templates","description":"Email Templates. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.templates.email.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/email_templates/{id}":{"get":{"tags":["Templates"],"parameters":[{"name":"id","in":"path","description":"Unique ID of the resource","required":true,"schema":{"type":"string","example":""}},{"name":"module","in":"query","description":"The API name of the module you want to fetch email template from.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/email-templates.html","api_endpoint":"https://{crm_host}/crm/v6/settings/email_templates/{id}"},"summary":"Email Templates ({id})","description":"Email Templates. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.templates.email.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/fields":{"get":{"tags":["Metadata"],"parameters":[{"name":"type","in":"query","description":"The value unused fetches all the unused fields and all fetches all both used and unused fields in the module.","required":false,"schema":{"type":"string","example":""}},{"name":"include","in":"query","description":"The value allowed_permissions_to_update returns the JSON object \"allowed_permissions\" which gives the default permissions enabled for a field.","required":false,"schema":{"type":"string","example":""}},{"name":"module","in":"query","description":"Specify the API name of the required module.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/field-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/fields"},"summary":"Fields Meta Data","description":"Fields Meta Data. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.fields.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/fields/{field_unique_ID}":{"get":{"tags":["Metadata"],"parameters":[{"name":"field_unique_ID","in":"path","description":"Unique ID of the field","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The value unused fetches all the unused fields and all fetches all both used and unused fields in the module.","required":false,"schema":{"type":"string","example":""}},{"name":"include","in":"query","description":"The value allowed_permissions_to_update returns the JSON object \"allowed_permissions\" which gives the default permissions enabled for a field.","required":false,"schema":{"type":"string","example":""}},{"name":"module","in":"query","description":"Specify the API name of the required module.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/field-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/fields/{field_unique_ID}"},"summary":"Fields Meta Data ({field_unique_ID})","description":"Fields Meta Data. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.fields.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/Appointments__s":{"get":{"tags":["Appointments"],"parameters":[{"name":"cvid","in":"query","description":"To get the list of appointments present in a custom view that you specify in this key.","required":false,"schema":{"type":"number","example":""}},{"name":"fields","in":"query","description":"To list all the appointments data with respect to the fields that you specify in this parameter.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of appointments from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"page_token","in":"query","description":"You can use the \"page\" param to fetch up to 2000 appointments without \"page_token\".","required":true,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"To get the list of appointments available per page.","required":false,"schema":{"type":"number","example":""}},{"name":"sort_by","in":"query","description":"To sort the appointments based on the fields id , Created_Time , and Modified_Time .","required":false,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"To sort the available list of appointments in either ascending or descending order.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-appointments.html","api_endpoint":"https://{crm_host}/crm/v6/Appointments__s"},"summary":"Appointments APIs","description":"Appointments APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.appointments.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/Appointments__s/{appointment_id}":{"get":{"tags":["Appointments"],"parameters":[{"name":"appointment_id","in":"path","description":"Unique ID of the appointment","required":true,"schema":{"type":"string","example":""}},{"name":"cvid","in":"query","description":"To get the list of appointments present in a custom view that you specify in this key.","required":false,"schema":{"type":"number","example":""}},{"name":"fields","in":"query","description":"To list all the appointments data with respect to the fields that you specify in this parameter.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of appointments from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"page_token","in":"query","description":"You can use the \"page\" param to fetch up to 2000 appointments without \"page_token\".","required":true,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"To get the list of appointments available per page.","required":false,"schema":{"type":"number","example":""}},{"name":"sort_by","in":"query","description":"To sort the appointments based on the fields id , Created_Time , and Modified_Time .","required":false,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"To sort the available list of appointments in either ascending or descending order.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-appointments.html","api_endpoint":"https://{crm_host}/crm/v6/Appointments__s/{appointment_id}"},"summary":"Appointments APIs ({appointment_id})","description":"Appointments APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.appointments.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/automation/assignment_rules":{"get":{"tags":["Automation"],"parameters":[{"name":"module","in":"query","description":"The API name of the module you want to fetch the assignment rule from.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-assignment-rules.html","api_endpoint":"https://{crm_host}/crm/v6/settings/automation/assignment_rules"},"summary":"Get Assignment Rules","description":"Get Assignment Rules. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.assignment_rules.{{operation-type}}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/automation/assignment_rules/{rule_id}":{"get":{"tags":["Automation"],"parameters":[{"name":"rule_id","in":"path","description":"Unique ID of the assignment rule","required":true,"schema":{"type":"string","example":""}},{"name":"module","in":"query","description":"The API name of the module you want to fetch the assignment rule from.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-assignment-rules.html","api_endpoint":"https://{crm_host}/crm/v6/settings/automation/assignment_rules/{rule_id}"},"summary":"Get Assignment Rules ({rule_id})","description":"Get Assignment Rules. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.assignment_rules.{{operation-type}}).","security":[{"bearerAuth":[]}]}},"/crm/v6/{module_api_name}/{record_id}/Attachments":{"get":{"tags":["Attachments"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Specify the API name of the field whose details you want to receive in the response.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-attachments.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}/Attachments"},"summary":"Files and Attachments APIs","description":"Files and Attachments APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/Contacts/roles":{"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-contact-roles.html","api_endpoint":"https://{crm_host}/crm/v6/Contacts/roles"},"summary":"Get Contact Roles","description":"Get Contact Roles. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/Contacts/roles/{contact_role_id}":{"get":{"tags":["Settings"],"parameters":[{"name":"contact_role_id","in":"path","description":"Unique ID of the contact role","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-contact-roles.html","api_endpoint":"https://{crm_host}/crm/v6/Contacts/roles/{contact_role_id}"},"summary":"Get Contact Roles ({contact_role_id})","description":"Get Contact Roles. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/{module_api_name}/deleted":{"get":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"Specify the type of deleted records you want to retrieve.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-deleted-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/deleted"},"summary":"Get List of Deleted Records","description":"Get List of Deleted Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/Notes":{"get":{"tags":["Notes"],"parameters":[{"name":"fields","in":"query","description":"Specify the API names of the fields whose details you want to receive in the response.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-notes.html","api_endpoint":"https://{crm_host}/crm/v6/Notes"},"summary":"Notes APIs","description":"Notes APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/Notes/{note_id}":{"get":{"tags":["Notes"],"parameters":[{"name":"note_id","in":"path","description":"Unique ID of the note","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Specify the API names of the fields whose details you want to receive in the response.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-notes.html","api_endpoint":"https://{crm_host}/crm/v6/Notes/{note_id}"},"summary":"Notes APIs ({note_id})","description":"Notes APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/{module_api_name}/{record_id}/Notes":{"get":{"tags":["Notes"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Specify the API names of the fields whose details you want to receive in the response.","required":true,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-notes.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}/Notes"},"summary":"Notes APIs ({module_api_name}, {record_id})","description":"Notes APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/org":{"get":{"tags":["Organization"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-org-data.html","api_endpoint":"https://{crm_host}/crm/v6/org"},"summary":"Organization API","description":"Organization API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.org.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/pipeline":{"get":{"tags":["Settings"],"parameters":[{"name":"layout_id","in":"query","description":"The unique ID of the layout in the Deals module you want to fetch the pipeline's details from.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-pipelines.html","api_endpoint":"https://{crm_host}/crm/v6/settings/pipeline"},"summary":"Get Pipelines in a Layout","description":"Get Pipelines in a Layout. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.pipeline.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/pipeline/{pipeline_ID}":{"get":{"tags":["Settings"],"parameters":[{"name":"pipeline_ID","in":"path","description":"Unique ID of the pipeline","required":true,"schema":{"type":"string","example":""}},{"name":"layout_id","in":"query","description":"The unique ID of the layout in the Deals module you want to fetch the pipeline's details from.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-pipelines.html","api_endpoint":"https://{crm_host}/crm/v6/settings/pipeline/{pipeline_ID}"},"summary":"Get Pipelines in a Layout ({pipeline_ID})","description":"Get Pipelines in a Layout. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.pipeline.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/profiles":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-profiles.html","api_endpoint":"https://{crm_host}/crm/v6/settings/profiles"},"summary":"Profiles","description":"Profiles. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.profiles.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/profiles/{profile_id}":{"get":{"tags":["Users"],"parameters":[{"name":"profile_id","in":"path","description":"Unique ID of the profile","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-profiles.html","api_endpoint":"https://{crm_host}/crm/v6/settings/profiles/{profile_id}"},"summary":"Profiles ({profile_id})","description":"Profiles. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.profiles.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/{module_api_name}/{record_id}/{related_list_api_name}":{"get":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}},{"name":"related_list_api_name","in":"path","description":"API name of the related list (e.g. Contacts, Notes, Attachments)","required":true,"schema":{"type":"string","example":""}},{"name":"converted","in":"query","description":"To get the list of converted records.","required":false,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Specify the API name of the field whose details you want to receive in the response.","required":true,"schema":{"type":"string","example":""}},{"name":"ids","in":"query","description":"To retrieve specific records based on their unique ID.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"page_token","in":"query","description":"You can use the \"page\" param to fetch up to 2000 records without \"page_token\".","required":true,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}},{"name":"sort_by","in":"query","description":"To sort the records based on the fields id , Created_Time , and Modified_Time .","required":false,"schema":{"type":"string","example":""}},{"name":"sort_order","in":"query","description":"To sort the available list of records in either ascending or descending order.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-related-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}/{related_list_api_name}"},"summary":"Related Records Data","description":"Related Records Data. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/{module_api_name}/{record_id}/actions/fetch_full_data":{"get":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}},{"name":"fields","in":"query","description":"Specify the API names of the rich text fields whose values you want to retrieve.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-rich-text-fields.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/{record_id}/actions/fetch_full_data"},"summary":"Get Rich Text Fields","description":"Get Rich Text Fields. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/roles":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-roles.html","api_endpoint":"https://{crm_host}/crm/v6/settings/roles"},"summary":"Roles APIs","description":"Roles APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.roles.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/roles/{role_id}":{"get":{"tags":["Users"],"parameters":[{"name":"role_id","in":"path","description":"Unique ID of the role","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-roles.html","api_endpoint":"https://{crm_host}/crm/v6/settings/roles/{role_id}"},"summary":"Roles APIs ({role_id})","description":"Roles APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.roles.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/users":{"get":{"tags":["Users"],"parameters":[{"name":"type","in":"query","description":"Specify the type of the users you want to retrieve.","required":false,"schema":{"type":"string","example":""}},{"name":"ids","in":"query","description":"Represents the unique ID of the users.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of user records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"To set the number of user records to be retrieved per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-users.html","api_endpoint":"https://{crm_host}/crm/v6/users"},"summary":"Users APIs","description":"Users APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.users.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/users/{user_id}":{"get":{"tags":["Users"],"parameters":[{"name":"user_id","in":"path","description":"Unique ID of the user","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"Specify the type of the users you want to retrieve.","required":false,"schema":{"type":"string","example":""}},{"name":"ids","in":"query","description":"Represents the unique ID of the users.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of user records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"To set the number of user records to be retrieved per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-users.html","api_endpoint":"https://{crm_host}/crm/v6/users/{user_id}"},"summary":"Users APIs ({user_id})","description":"Users APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.users.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/variables":{"get":{"tags":["Settings"],"parameters":[{"name":"group","in":"query","description":"Specify the unique ID/API name of the group to which the variable belongs.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-variables.html","api_endpoint":"https://{crm_host}/crm/v6/settings/variables"},"summary":"Variables API","description":"Variables API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.variables.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/variables/{variable_id}":{"get":{"tags":["Settings"],"parameters":[{"name":"variable_id","in":"path","description":"Unique ID of the variable","required":true,"schema":{"type":"string","example":""}},{"name":"group","in":"query","description":"Specify the unique ID/API name of the group to which the variable belongs.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-variables.html","api_endpoint":"https://{crm_host}/crm/v6/settings/variables/{variable_id}"},"summary":"Variables API ({variable_id})","description":"Variables API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.variables.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/wizards":{"get":{"tags":["Settings"],"parameters":[{"name":"layout_id","in":"query","description":"The ID of the layout that you want to fetch the wizard's details from.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-wizards.html","api_endpoint":"https://{crm_host}/crm/v6/settings/wizards"},"summary":"Wizards API","description":"Wizards API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/wizards/{wizard_ID}":{"get":{"tags":["Settings"],"parameters":[{"name":"wizard_ID","in":"path","description":"Unique ID of the wizard","required":true,"schema":{"type":"string","example":""}},{"name":"layout_id","in":"query","description":"The ID of the layout that you want to fetch the wizard's details from.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/get-wizards.html","api_endpoint":"https://{crm_host}/crm/v6/settings/wizards/{wizard_ID}"},"summary":"Wizards API ({wizard_ID})","description":"Wizards API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/layouts":{"get":{"tags":["Metadata"],"parameters":[{"name":"module","in":"query","description":"Specify the API name of the required module.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/layouts-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/layouts"},"summary":"Layouts Metadata","description":"Layouts Metadata. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.layouts.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/layouts/{layout_id}":{"get":{"tags":["Metadata"],"parameters":[{"name":"layout_id","in":"path","description":"Unique ID of the layout","required":true,"schema":{"type":"string","example":""}},{"name":"module","in":"query","description":"Specify the API name of the required module.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/layouts-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/layouts/{layout_id}"},"summary":"Layouts Metadata ({layout_id})","description":"Layouts Metadata. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.layouts.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/Leads/{record_id}/__conversion_options":{"get":{"tags":["Lead Conversion"],"parameters":[{"name":"record_id","in":"path","description":"Unique ID of the record","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/lead-conversion-options.html","api_endpoint":"https://{crm_host}/crm/v6/Leads/{record_id}/__conversion_options"},"summary":"Lead Conversion Options","description":"Lead Conversion Options. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/modules/{module_api_name}":{"get":{"tags":["Metadata"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/module-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/modules/{module_api_name}"},"summary":"Metadata APIs","description":"Metadata APIs. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/modules":{"get":{"tags":["Metadata"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/modules-api.html","api_endpoint":"https://{crm_host}/crm/v6/settings/modules"},"summary":"Modules API","description":"Modules API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.ALL).","security":[{"bearerAuth":[]}]}},"/crm/v6/actions/watch":{"delete":{"tags":["Notifications"],"parameters":[{"name":"channel_ids","in":"query","description":"Specify the unique IDs of the notification channels to be disabled, separated by commas.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/notifications__disable.html","api_endpoint":"https://{crm_host}/crm/v6/actions/watch"},"summary":"Disable Notifications","description":"Disable Notifications. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.notifications.{operations_type}).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Notifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/notifications__enable.html","api_endpoint":"https://{crm_host}/crm/v6/actions/watch"},"summary":"Enable Notifications","description":"Enable Notifications. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.notifications.{operation_type}).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"watch":{"type":"array","description":"Array of notification channel objects","required":true,"items":{"type":"object","properties":{"channel_expiry":{"type":"string","description":"String value","required":true},"channel_id":{"type":"string","description":"String value","required":true},"events":{"type":"array","description":"Array value","required":true},"notification_condition":{"type":"array","description":"Array value","required":true},"notify_url":{"type":"string","description":"String value","required":true},"return_affected_field_values":{"type":"boolean","description":"Boolean value","required":true},"token":{"type":"string","description":"String value","required":true}}}}}},"example":{"watch":[]}}}}},"get":{"tags":["Notifications"],"parameters":[{"name":"channel_id","in":"query","description":"Specify the unique ID of the notification channel.","required":true,"schema":{"type":"number","example":""}},{"name":"module","in":"query","description":"Specify the API name of the module for which the notification is enabled.","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"To get the list of records from the respective pages.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"To get the list of records available per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/notifications__get-details.html","api_endpoint":"https://{crm_host}/crm/v6/actions/watch"},"summary":"Get Notification Details","description":"Get Notification Details. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.notifications.{operation_type}).","security":[{"bearerAuth":[]}]},"patch":{"tags":["Notifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/notifications__specific-disable.html","api_endpoint":"https://{crm_host}/crm/v6/actions/watch"},"summary":"Disable Specific Notifications","description":"Disable Specific Notifications. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.notifications.{operation_type}).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"watch":{"type":"array","description":"Array of notification channel objects","required":true,"items":{"type":"object","properties":{"_delete_events":{"type":"boolean","description":"Boolean value","required":true},"channel_id":{"type":"string","description":"String value","required":true},"events":{"type":"array","description":"Array value","required":true}}}}}},"example":{"watch":[]}}}}},"put":{"tags":["Notifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/notifications__update-details.html","api_endpoint":"https://{crm_host}/crm/v6/actions/watch"},"summary":"Update Details of a Notification","description":"Update Details of a Notification. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.notifications.{operation_type}).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"watch":{"type":"array","description":"Array of notification channel objects","required":true,"items":{"type":"object","properties":{"channel_expiry":{"type":"string","description":"String value","required":true},"channel_id":{"type":"string","description":"String value","required":true},"events":{"type":"array","description":"Array value","required":true},"notification_condition":{"type":"array","description":"Array value","required":true},"notify_url":{"type":"string","description":"String value","required":true},"token":{"type":"string","description":"String value","required":true}}}}}},"example":{"watch":[]}}}}}},"/crm/v6/settings/related_lists":{"get":{"tags":["Metadata"],"parameters":[{"name":"layout_id","in":"query","description":"Specify the unique ID of the layout to fetch the metadata of the related lists specific to that layout.","required":false,"schema":{"type":"string","example":""}},{"name":"module","in":"query","description":"Specify the API name of the required module.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/related-list-meta.html","api_endpoint":"https://{crm_host}/crm/v6/settings/related_lists"},"summary":"Related Lists Metadata","description":"Related Lists Metadata. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.related_lists.READ).","security":[{"bearerAuth":[]}]}},"/crm/v6/{module_api_name}/search":{"get":{"tags":["Search"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}},{"name":"criteria","in":"query","description":"Performs search by following the shown criteria.","required":false,"schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"Search records by the email field value.","required":false,"schema":{"type":"string","example":""}},{"name":"phone","in":"query","description":"Search records by the phone field value.","required":false,"schema":{"type":"string","example":""}},{"name":"word","in":"query","description":"Search records that contain this word in any field.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/search-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/search"},"summary":"Search Records","description":"Search Records. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.{module_name}.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/territories":{"get":{"tags":["Settings"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/territories.html","api_endpoint":"https://{crm_host}/crm/v6/settings/territories"},"summary":"Territories API","description":"Territories API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.territories.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/settings/territories/{territoryid}":{"get":{"tags":["Settings"],"parameters":[{"name":"territoryid","in":"path","description":"Unique ID of the territory","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/territories.html","api_endpoint":"https://{crm_host}/crm/v6/settings/territories/{territoryid}"},"summary":"Territories API ({territoryid})","description":"Territories API. Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.settings.territories.{operation_type}).","security":[{"bearerAuth":[]}]}},"/crm/v6/files":{"post":{"tags":["Files"],"parameters":[{"name":"type","in":"query","description":"To upload inline images.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/upload-files-to-zfs.html","api_endpoint":"https://{crm_host}/crm/v6/files"},"summary":"Upload Files to Zoho File System (ZFS)","description":"Upload Files to Zoho File System (ZFS). Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.Files.{operation_type}).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"File to upload to Zoho File Storage (ZFS)","required":true}}},"example":{"file":"(binary)"}}}}}},"/crm/v6/{module_api_name}/upsert":{"post":{"tags":["Records"],"parameters":[{"name":"module_api_name","in":"path","description":"API name of the module (e.g. Leads, Contacts, Deals, Quotes or a custom module's API name from Setup > Developer Hub > API Names)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/crm/developer/docs/api/v6/upsert-records.html","api_endpoint":"https://{crm_host}/crm/v6/{module_api_name}/upsert"},"summary":"Insert or Update Records (Upsert)","description":"Insert or Update Records (Upsert). Host: https://www.zohoapis.com (default US DC; Zoho CRM v6 API DC hosts: www.zohoapis.com, www.zohoapis.eu, www.zohoapis.in, www.zohoapis.com.au, www.zohoapis.jp). Auth: OAuth 2.0 access token via Authorization: Zoho-oauthtoken (scope ZohoCRM.modules.ALL).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"array","description":"Array of record objects to process (field API names as keys; use the Fields Metadata API for valid keys)","required":true,"items":{"type":"object","properties":{"$append_values":{"type":"object","description":"Nested object","required":true},"Company":{"type":"string","description":"String value","required":true},"Email":{"type":"string","description":"String value","required":true},"Foreign_Languages":{"type":"array","description":"Array value","required":true},"Last_Name":{"type":"string","description":"String value","required":true},"Lead_Status":{"type":"string","description":"String value","required":true}}}},"duplicate_check_fields":{"type":"array","description":"API names of fields used to identify duplicate records during upsert","required":true,"items":{"type":"string"}},"trigger":{"type":"array","description":"Automation to trigger: workflow, approval, blueprint, pathfinder or orchestration. [] executes none","required":true,"items":{"type":"string"}}}},"example":{"data":[],"duplicate_check_fields":[],"trigger":[]}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}