Photos and Attachments APIs

Overview

Attachments provide more information about a contact or a company, which normally cannot be displayed. You may also need to send images, text files or videos or any other type of files to contacts. The photos and attachments API allows you to get a list of attachments, upload or download a photo or a file.

Endpoints

GET /{module_api_name}/{record_id}/Attachments

Get attachments

Retrieves the list of available attachments associated to a record in a module.

Request URL

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

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 necessary module. 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.

Query parameters

fields stringRequired

Specify the fields you want to retrieve in the API response. It accepts multiple field API names separated by commas. You can get the field API names from the Fields Metadata API by accessing the api_name value for each field. For example, if you want to fetch attachments and include fields like File_Name and Size, you can pass them as fields=File_Name,Size.

You can pass up to 50 fields.

page integerOptional

Represents the page index. This parameter lists the records from the given page index. The default value is 1.

per_page integerOptional

Represents the number of records per page index. The default value is 200, which means up to 200 records can be retrieved per page index.

Sample request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000478332/Attachments?fields=File_Name,$file_id,Size,Parent_Id" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000478332/Attachments?fields=File_Name,$file_id,Size,Parent_Id"
	type: GET
	connection:"bigin_oauth_connection"
];
info response;

Response object

The response object contains a list of attachments belonging to a specified record, filtered based on the query parameters provided.

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 read attachment details
Resolution: The user does not have permission to read attachment details. 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 read attachments
Resolution: The user does not have the permission to read attachment details. Contact your system administrator.

Sample response

Copied{
    "data": [
        {
            "File_Name": "wellness-retreat.pdf",
            "Size": "7544",
            "Parent_Id": null,
            "id": "2034020000000703037",
            "$file_id": "kvjww7732c6fd16684d49b56f78010e7f20b3"
        },
        {
            "File_Name": "wellness-retreat1.jpg",
            "Size": "3134197",
            "Parent_Id": null,
            "id": "2034020000000703026",
            "$file_id": "kvjww524b4dc760d24f5cabeafb4b859da36b"
        },
        {
            "File_Name": "wellness-retreat2.jpg",
            "Size": "2570034",
            "Parent_Id": null,
            "id": "2034020000000703025",
            "$file_id": "kvjwwf1c41e88d1a64f59ab3cf5280f7399a9"
        }
    ],
    "info": {
        "per_page": 200,
        "next_page_token": null,
        "count": 3,
        "page": 1,
        "previous_page_token": null,
        "page_token_expiry": null,
        "more_records": false
    }
}