Download Inline Images of an Email

Purpose

To download the inline images from an email.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_id}/Emails/actions/download_inline_images

Supported modules

Leads, Accounts, Contacts, Deals, Quotes, Invoices, Sales Orders, Purchase Orders, and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.READ
or
scope=ZohoCRM.modules.{module_name}.READ
and
scope=ZohoCRM.modules.emails.READ

Possible Module Names

leads, accounts, contacts, deals, quotes, invoices, salesorders, purchaseorders, and custom

Parameters

  • message_idmandatory

    The message ID you get in the response when you send an email. Refer to the "message_id" key in the response of Send Mail API or Get Emails of a Record API to get the message ID.

  • user_idmandatory

    The unique ID of the record owner whose email you want to retrieve. Use the Get Users API to get the user's ID.

  • idmandatory

    The unique ID of the inline image sent in the email. Refer to the img_id property in the "content" key of the response of Get Emails of a Record API for this ID.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v4/Leads/3652397000002379001/Emails/actions/download_inline_images?message_id=2cceaxxxx1d60b8&user_id=3652397000000281001&id=141207xxxxade84fe"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"