Overview
What's New in V5?
Changelog
API Collection
OAuth Authentication
- Overview
- Scopes
- Step1: Registering a Client
- Step2: Making the Authorization Request
- Step3: Generating Tokens
- Step 4: Refreshing your Access Tokens
- Step 5: Revoking Tokens
- Client Credentials
- Incremental Authorization
- Token Validity
API Limits
Multi DC Support
Increase API Credits
Customize API Usage Notification
GDPR Compliance
HIPAA Compliance
API Dashboard
HTTP Request Methods
Status Codes
Metadata APIs
- Modules
  - GETModules
  - GETSpecific Module
- Fields
  - GETFields
- Layouts
  - GETLayouts
- Related Lists
  - GETRelated Lists
- Profiles
  - GETProfiles
  - POSTProfiles
  - PUTProfile Permissions
  - DELETETransfer Users and Delete a Profile
- Custom View
  - GETCustom View
  - PUTSort Order
- Roles
  - GETRoles
  - POSTRole
  - PUTRole
  - DELETETransfer Users and Delete Role
- Territories
  - GETTerritories
  - POSTTerritories
  - PUTTerritories
  - DELETETerritories
  - POSTTransfer and Delete Territories
  - GETChild Territories of a Territory
  - POSTAssign Territories to Records
  - GETTerritories Assigned
  - POSTRemove Territories of Records
  - GETAssociated User Count
  - PUTAssociate Users with Territory
  - DELETEDisassociate Users from Territory
  - GETRetrieve User details Associated with a Territory
- Scoring Rules
  - GETScoring Rules
  - POSTScoring Rules
  - PUTScoring Rules
  - PUTExecute Scoring Rules
  - GETEntity Score
  - PUTScoring Rule Status
  - POSTClone Scoring Rule
  - DELETEScoring Rules
  - GETSignals
- Variables
  - GETVariables
  - GETVariable Groups
  - POSTVariables
  - PUTVariables
  - DELETEVariables
- Map Dependency
  - POSTMap Dependency
  - PUTMapped Dependency Fields
  - DELETEMapped Dependency
  - GETMapped Dependency Fields
- User Groups
  - POSTUser Group
  - PUTUser Group
  - GETUser Groups
  - GETSources Count
  - GETSources by Type
  - DELETEDelete User Group
  - GETAssociated Groups of a User
  - GETAssociated Users' Count in User Groups
  - GETUser Group Associations
- Tags
  - GETTags
  - POSTTags
  - PUTTags
  - DELETETags
  - POSTAdd Tags to Records
  - GETRecord Count for a Specific Tag
  - POSTRemove Tags from Records
  - POSTMerge Tags
- Pipeline
  - POSTPipeline
  - PUTPipeline
  - GETPipelines
  - POSTTransfer and Delete a Pipeline
- Wizards
  - GETWizards
- Assignment Rules
  - GETAssignment Rules
- Templates
  - GETEmail Templates
  - GETInventory Templates
- User's Unavailability
  - POSTUser's Unavailable
  - GETUsers' Unavailability
  - PUTUser's Unavailability
  - DELETEUser's Unavailability
- Portals
  - POSTPortal
  - PUTPortal
  - GETPortals
  - POSTUser Type
  - GETUser Types
  - PUTUser Type
  - DELETEUser Type
  - POSTInvite a User to a Portal
  - POSTBulk Invite Users
  - GETBulk Invite Status
  - PUTTransfer Users of a User Type
  - GETUsers of a User Type
  - PUTChange User's Status
  - DELETEDelete User from the Portal
- Fiscal Year
  - GETFiscal Year
  - PUTFiscal Year
- Business Hours
  - GETBusiness Hours
  - POSTBusiness Hours
  - PUTBusiness Hours
- Holidays
  - PUTHoliday
  - POSTHolidays
  - GETList of Holidays
  - DELETEHoliday
- Record Locking Configuration
  - GETRecord Locking Configuration
  - POSTRecord Locking Configuration
  - PUTRecord Locking Configuration
  - DELETERecord Locking Configuration
- Shift Hours
  - GETShift Hours
  - POSTShift Hours
  - PUTShift Hours
  - DELETEShift Hour
Entity APIs
- Organization
  - GETOrganization Details
  - POSTUpload Organization Photo
  - GETOrganization Photo
  - DELETEOrganization Photo
- Users
  - GETUsers
  - POSTUser
  - PUTUser
  - DELETEUser
  - GETUsers Count
  - GETTerritories of a User
  - PUTAdd or Update Territories of a User
  - PUTDelink and Transfer Records
  - GETValidate before Transferring
  - POSTTransfer Records and Delete Users
  - GETStatus of Transfer Records and Delete Users
- Records
  - GETRecords
  - POSTRecords
  - PUTRecords
  - DELETEDelete Records
  - POSTUpsert Records
  - GETSearch Records
  - GETList of Deleted Records
  - GETRecord Count in a Module
  - GETTimeline of a Record
  - Convert Lead
  - Services
  - Appointments
  - Appointments Rescheduled History
  - Mail Merge
- Related Records
  - GETRelated Records
  - PUTRelated Records
  - DELETEDelink Related Records
  - Record Locking
- Records APIs using External ID
  - Overview
  - GETRecords Using External ID
  - POSTRecords using External ID
  - PUTRecords Using External ID
  - DELETERecords Using External ID
  - POSTUpsert Records Using External ID
  - GETSearch Records Using External ID
- Meeting Cancel
  - POSTMeeting Cancel
- Subforms
  - GETSubform
  - POSTSubform Data
  - PUTSubform Data
- Linking Modules
  - Linking Modules
- Contact Roles
  - GETContact Roles
  - POSTContact Roles
  - PUTContact Roles
  - DELETEContact Roles
  - GETContact Roles of a Specific Deal
  - PUTAdd Contact Roles to a Specific Deal
  - DELETERemove Contact Roles from a Specific Deal
- Photos and Attachments
  - GETList of Attachments
  - POSTAttachment
  - GETDownload an Attachment
  - DELETEAttachment
  - POSTPhoto
  - GETPhoto
  - DELETEPhoto
- Mass Update
  - POSTMass Update Records
  - GETMass Update Status
- Mass Delete
  - POSTMass Delete Records
  - GETMass Delete Status
- Currencies
  - GETCurrencies Data
  - POSTCurrencies
  - PUTCurrencies
  - POSTEnable Multi-Currency
- Files
  - GETFiles
  - POSTUpload Files to Zoho File System (ZFS)
- Share
  - GETShare Records
  - POSTShare Records
  - PUTShare Permissions
  - DELETERevoke Shared Records
- Fields' Attachments
  - GETDownload Field Attachments
- Change Owner
  - POSTChange Owner
- Mass Change Owner
  - POSTMass Change Owner
  - GETMass Change Owner Status
- Blueprint
  - GETBlueprint
  - PUTBlueprint Details
- Emails
  - POSTAssociate Email with a Record
  - GETDownload Email Attachments
  - GETDownload Inline Images of an Email
  - GETEmail Shared Details
  - GETEmails of a Record
  - GETList of Allowed "from" Addresses
  - POSTSend Mail
- Notes
  - POSTNotes
  - GETNotes
  - PUTNotes
  - DELETENotes
- Related Records Using External ID
  - GETRelated Records Using External ID
  - PUTRelated Records Using External ID
  - DELETERelated Records Using External ID
Composite API
- Overview
- POSTComposite Request
Bulk APIs
- Data Backup
- Bulk Read
- Bulk Write
Notification APIs
- Overview
- GETNotification Details
- POSTEnable Notifications
- PATCHUpdate Specific Information of a Notification
- PUTDetails of a Notification
- DELETEDisable Notifications
- PATCHDisable Specific Notifications
Query API
- Overview
- POSTRecords through a COQL Query
- Limitations

Download Field Attachments

Purpose

To download the attachments from the file upload and image upload fields of a module.

Endpoints

GET /{module_api_name}/{record_ID}/actions/download_fields_attachment

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_ID}/actions/download_fields_attachment

Supported modules

Leads, Accounts, Contacts, Deals, Tasks, Meetings, Calls, Products, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Campaigns, Vendors, Cases, Solutions, and Custom

Header

Authorization: Zoho-oauthtoken <access_token>

Scope

scope=ZohoCRM.modules.{module_name}.READ

Parameters

fields_attachment_idstring, mandatory
The unique ID of the attachment of either the file upload field or the image upload field in the module. You can obtain this ID using the Get Records API for that specific record.

Possible Errors

INVALID_DATAHTTP 400
The ID of the record is invalid.
Resolution: Specify the correct record ID.
NO_PERMISSIONHTTP 403
You do not have permission to download the attachments of the record in this module.
Resolution: Contact your administrator.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/Leads/554023000001054001/actions/download_fields_attachment?fields_attachment_id=554023000001736007"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxxxxxfa"