Sign in Try for Free

Menu

Zoho CRM actions

Pick an action to see its parameters, request body and response fields.

137 actions

Attachments · 4

DELETEDelete Link Attachment/{moduleApiName}/{recordId}/Attachments/{id}Delete Link Attachment GETDownload a specific attachment file/{moduleApiName}/{recordId}/Attachments/{id}Download a specific attachment file GETRetrieve All Attachments/{moduleApiName}/{recordId}/AttachmentsRetrieve All Attachments POSTUpload an Attachment/{moduleApiName}/{recordId}/AttachmentsUpload an Attachment

Bulk Read · 3

POSTCreate a bulk read job/readCreate a bulk read job GETDownload bulk read result/read/{jobId}/resultDownload bulk read result GETGet bulk read job details/read/{jobId}Get bulk read job details

Bulk Write · 2

POSTCreate a bulk write job/writeCreate a bulk write job GETGet bulk write job details/write/{jobId}Get bulk write job details

Composite · 1

POSTProcess multiple API requests in a single call/__composite_requestsProcess multiple API requests in a single call

COQL · 1

POSTRetrieve records using a COQL query/coqlRetrieve records using a COQL query

Email · 2

GETList email templates/settings/email_templatesList email templates POSTSend an email to a record/{moduleName}/{id}/actions/send_mailSend an email to a record

Files · 3

GETRetrieve a file from ZFS/filesRetrieve a file from ZFS POSTUpload a file to CRM/uploadUpload a file to CRM POSTUpload files to ZFS/filesUpload files to ZFS

Leads · 1

POSTConvert a Lead/Leads/{leadId}/actions/convertConvert a Lead

Metadata · 29

PUTChange a custom view's sort order/settings/custom_views/{id}/actions/change_sortChange a custom view's sort order PUTChange custom views' sort order/settings/custom_views/actions/change_sortChange custom views' sort order POSTCreate a custom module/settings/modulesCreate a custom module POSTCreate a custom view/settings/custom_viewsCreate a custom view POSTCreate custom fields in a module/settings/fieldsCreate custom fields in a module DELETEDelete a custom field/settings/fields/{fieldId}Delete a custom field DELETEDelete a custom layout/settings/layouts/{id}Delete a custom layout DELETEDelete a picklist field option/settings/fields/{fieldId}/pick_list_values/{pickListValueId}Delete a picklist field option DELETEDelete Custom Views/settings/custom_viewsDelete Custom Views GETGenerate web-tab link for a module/settings/module/{moduleid}/actions/generate_linkGenerate web-tab link for a module GETGet a picklist field option/settings/fields/{fieldId}/pick_list_values/{pickListValueId}get a picklist field option GETGet All Custom Views/settings/custom_viewsGet All Custom Views GETGet Custom View By Id/settings/custom_views/{id}Get Custom View By Id GETGet field metadata by ID/settings/fields/{fieldId}Get field metadata by ID GETGet layout by ID/settings/layouts/{id}Get layout by ID GETGet layouts metadata/settings/layoutsGet layouts metadata GETGet module metadata by API name/settings/modules/{moduleIdentifier}Get module metadata by API name GETGet scheduled jobs for a field/settings/fields/{fieldId}/actions/scheduled_jobsGet scheduled jobs for a field GETList fields metadata/settings/fieldsList fields metadata GETPicklist Values for a Field/settings/fields/{fieldId}/pick_list_valuesPicklist Values for a Field POSTReplace Pick list values/settings/fields/{fieldId}/actions/replace_pick_list_valuesReplace Pick list values GETRetrieve modules/settings/modulesRetrieve modules PATCHUpdate a custom field/settings/fields/{fieldId}Update a custom field PATCHUpdate a custom layout/settings/layouts/{id}Update a custom layout PUTUpdate a custom view/settings/custom_views/{id}Update a custom view PUTUpdate CRM modules/settings/modulesUpdate CRM modules PATCHUpdate custom fields/settings/fieldsUpdate custom fields PUTUpdate custom views/settings/custom_viewsUpdate custom views PUTUpdate Module Labels and Profiles/settings/modules/{moduleIdentifier}Update Module Labels and Profiles

Notes · 14

POSTAdd notes to a record/{parentRecordModule}/{parentRecordId}/NotesAdd notes to a record POSTCreate notes/NotesCreate notes DELETEDelete a note/Notes/{id}Delete a note DELETEDelete a record's note/{parentRecordModule}/{parentRecordId}/Notes/{noteId}Delete a record's note DELETEDelete a record's notes/{parentRecordModule}/{parentRecordId}/NotesDelete a record's notes DELETEDelete notes/NotesDelete notes GETGet a note/Notes/{id}Get a note GETGet a record's note/{parentRecordModule}/{parentRecordId}/Notes/{noteId}Get a record's note GETList a record's notes/{parentRecordModule}/{parentRecordId}/NotesList a record's notes GETList notes/NotesList notes PUTUpdate a note/Notes/{id}Update a note PUTUpdate a record's note/{parentRecordModule}/{parentRecordId}/Notes/{noteId}Update a record's note PUTUpdate a record's notes/{parentRecordModule}/{parentRecordId}/NotesUpdate a record's notes PUTUpdate notes/NotesUpdate notes

Organisation · 8

POSTCreate currencies/org/currenciesCreate currencies POSTEnable multi-currency/org/currencies/actions/enableEnable multi-currency GETGet a currency/org/currencies/{currency}Get a currency GETGet organization details/orgGet organization details GETList currencies/org/currenciesList currencies PUTUpdate a currency/org/currencies/{currency}Update a currency PUTUpdate base currency/org/currencies/actions/enableUpdate base currency PUTUpdate currencies/org/currenciesUpdate currencies

Records · 20

POSTChange a record's owner/{module}/{record}/actions/change_ownerChange a record's owner POSTChange owner of records/{module}/actions/change_ownerChange owner of records GETCount records in a module/{moduleApiName}/actions/countCount records in a module POSTCreate or update records in a specified module/{module}/upsertCreate or update records in a specified module POSTCreate records in a specified module/{module}Create records in a specified module DELETEDelete a specific record by ID/{module}/{recordId}Delete a specific record by ID DELETEDelete records from a specified module/{module}Delete records from a specified module GETGet a record by ID from a specified module/{module}/{recordId}Get a record by ID from a specified module GETGet a record's sharing/{moduleApiName}/{recordId}/actions/shareGet a record's sharing GETGet deleted records from a specified module/{module}/deletedGet deleted records from a specified module GETGet mass update job status/{module}/actions/mass_updateGet mass update job status GETGet records from a specified module/{module}Get records from a specified module GETGet Timelines/{module}/{recordId}/__timelineGet Timelines POSTMass update records/{module}/actions/mass_updateMass update records POSTRecord Clone/{module}/{recordId}/actions/cloneRecord Clone DELETERevoke sharing on a record/{moduleApiName}/{recordId}/actions/shareRevoke sharing on a record POSTShare a record/{moduleApiName}/{recordId}/actions/shareShare a record PUTUpdate a specific record by ID/{module}/{recordId}Update a specific record by ID PUTUpdate records in a specified module/{module}Update records in a specified module PUTUpdate share permissions/{moduleApiName}/{recordId}/actions/shareUpdate share permissions

Related Records · 8

DELETEDelink a related record/{parentRecordModule}/{parentRecord}/{relatedList}/{record}Delink a related record DELETEDelink related records/{parentRecordModule}/{parentRecord}/{relatedList}Delink related records GETGet a related record/{parentRecordModule}/{parentRecord}/{relatedList}/{record}Get a related record POSTGet related records count/{moduleApiName}/{recordId}/actions/get_related_records_countGet related records count GETList deleted related records/{parentRecordModule}/deleted/{parentRecord}/{relatedList}List deleted related records GETList related records/{parentRecordModule}/{parentRecord}/{relatedList}List related records PUTUpdate a related record/{parentRecordModule}/{parentRecord}/{relatedList}/{record}Update a related record PUTUpdate related records/{parentRecordModule}/{parentRecord}/{relatedList}Update related records

Search · 2

POSTBulk Search Records by Criteria, Word, Email, or Phone/{module}/bulk/searchBulk Search Records by Criteria, Word, Email, or Phone GETSearch Records by Criteria, Word, Email, or Phone/{module}/searchSearch Records by Criteria, Word, Email, or Phone

Tags · 11

POSTAdd Tags to a Record/{module}/{id}/actions/add_tagsAdd Tags to a Record POSTAdd Tags to Records/{module}/actions/add_tagsAdd Tags to Records POSTCreate tags/settings/tagsCreate tags DELETEDelete tag by ID/settings/tags/{id}Delete tag by ID GETGet Tag Records Count/settings/tags/{id}/actions/records_countGet Tag Records Count GETList tags/settings/tagsList tags POSTMerge Tags/settings/tags/{id}/actions/mergeMerge Tags POSTRemove Tags from a Record/{module}/{id}/actions/remove_tagsRemove Tags from a Record POSTRemove Tags from Records/{module}/actions/remove_tagsRemove Tags from Records PUTUpdate tag by ID/settings/tags/{id}Update tag by ID PUTUpdate tags/settings/tagsUpdate tags

Users · 18

POSTClone a CRM profile/settings/profiles/{id}/actions/cloneClone a CRM profile POSTCreate a role/settings/rolesCreate a role POSTCreate User/usersCreate User DELETEDelete a profile/settings/profiles/{id}Delete a profile DELETEDelete a role/settings/roles/{role}Delete a role DELETEDelete a user from the organization/users/{user}Delete a user from the organization GETGet a profile/settings/profiles/{id}Get a profile GETGet a role/settings/roles/{role}Get a role GETGet a specific user/users/{user}Get a specific user GETGet all roles/settings/rolesGet all roles GETGet users/usersGet users GETList profiles/settings/profilesList profiles PUTUpdate a profile/settings/profiles/{id}Update a profile PATCHUpdate a profile's permissions/settings/profiles/{id}Update a profile's permissions PUTUpdate a role/settings/roles/{role}Update a role PUTUpdate a single user by user ID/users/{user}Update a single user by user ID PUTUpdate roles/settings/rolesUpdate roles PUTUpdate users/usersUpdate users

Webhooks · 10

POSTCreate webhooks/settings/automation/webhooksCreate webhooks DELETEDelete a webhook by ID/settings/automation/webhooks/{webhookId}Delete a webhook by ID DELETEDelete one or more webhooks/settings/automation/webhooksDelete one or more webhooks GETGet webhook action usage reports/settings/automation/webhooks/actions/usage_reportsGet webhook action usage reports GETGet webhook by ID/settings/automation/webhooks/{webhookId}Get webhook by ID GETGet webhook execution failure records/settings/automation/webhook_failuresGet webhook execution failure records GETGet webhook-associated modules/settings/automation/webhooks/actions/associated_modulesGet webhook-associated modules GETGet webhooks/settings/automation/webhooksGet webhooks PUTUpdate webhook by ID/settings/automation/webhooks/{webhookId}Update webhook by ID PUTUpdate webhooks/settings/automation/webhooksUpdate webhooks