Download an attachment

Download an attachment attached to a particular record.

Endpoints

Request URL

{api-domain}/bigin/v2/{module_api_name}/{record_id}/Attachments/{attachment_id}

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

  • For US, https://www.zohoapis.com
  • For EU, https://www.zohoapis.eu
  • For AU, https://www.zohoapis.com.au
  • For IN, https://www.zohoapis.in
  • For CN, https://www.zohoapis.com.cn
  • For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

 

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

  • ZohoBigin.modules.ALL and ZohoBigin.modules.attachments.ALL
  • ZohoBigin.modules.ALL and ZohoBigin.modules.attachments.READ
  • ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.attachments.ALL
  • ZohoBigin.modules.{module_name}.READ and ZohoBigin.modules.attachments.READ
  • ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.attachments.READ
  • ZohoBigin.modules.{module_name}.READ and ZohoBigin.modules.attachments.ALL

In the above scope, replace {module_name} with the module for which you want to retrieve the records. The possible modules include pipelines, contacts, accounts (companies in Bigin), products, events, tasks, and notes.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

Module

API Name

Contacts

Contacts

Pipelines

Pipelines

Companies

Accounts

Products

Products

Tasks

Tasks

Events

Events

Notes

Notes

record_id stringRequired

The unique identification of a record in a module. You can get the record ID from the Get records API.

attachment_id stringRequired

The unique identification of an attachment that is attached to a record. You can get the attachment ID from the Get attachments API.

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000489124/Attachments/2034020000000711002" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000489124/Attachments/2034020000000711002"
	type: GET
	connection:"connection_link_name"
];
info response;

Response object

The response object is not available for this API. It downloads the requested attachment from a particular record upon successful API call.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have ZohoBigin.modules.attachments.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to download attachment
    Resolution: The user does not have permission to download attachments. Contact your system administrator.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • AUTHORIZATION_FAILEDHTTP 400

    User does not have sufficient privilege to download attachments
    Resolution: The user does not have the permission to download attachments. Contact your system administrator.

Sample response

Copied200 OK