Upload an Attachment

Purpose

To attach a file to a record. You must include the attachment in the request with content type as multipart/form data.

Request Details

Request URL

https://www.zohoapis.com/bigin/v1/{module_api_name}/{record_id}/Attachments

Possible module names

Modules supported in Get List of Attachments are supported here.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoBigin.modules.ALL
(or)
scope=ZohoBigin.modules.{module_name}.{operation_type}
(and)
scope=ZohoBigin.modules.attachments.{operation_type}

Possible module names

companies, contacts, deals, tasks, events, products, notes and activities.

Possible operation types

ALL - Full access to attachments
WRITE - Edit attachment data
CREATE - Create attachment data

Parameters

  • filefile, mandatory

    Choose the attachment you want to upload.

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/1000000231009/Attachments"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-F "file=@attachment1.txt" (to upload file) 
(or)
-F "attachmentUrl=https://www.zohocorp.com" (to upload link)
CopiedZBiginRecord record = ZBiginRecord.getInstance("Products",23857634545l);//module api name with record id
APIResponse response = record.uploadAttachment("FilePath");
ZBiginAttachment uploadAttachment = (ZBiginAttachment) response.getData();
String requestStatus =response.getStatus();
Copiedtry{
$record=ZBiginRecord::getInstance(“Contacts”,”410405000001111007”);
$responseIns=$record->uploadAttachment($filePath); // $filePath - absolute path of the attachment to be uploaded.
echo "HTTP Status Code:".$responseIns->getHttpStatusCode();
echo "Status:".$responseIns->getStatus();
echo "Message:".$responseIns->getMessage();
echo "Code:".$responseIns->getCode();
echo "Details:".$responseIns->getDetails()['id'];
}catch(ZBiginException $e)
{
echo $e->getCode();
echo $e->getMessage();
echo $e->getExceptionCode();
}
Copieddef upload_attachment(self):
        try:
            record = ZBiginRecord.get_instance('Contacts', 3719520000000326007)
            resp = record.upload_attachment('/Users/Downloads/pic1.png')
            print(resp.data.id)
        except ZBiginException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)
CopiedZBiginRecord recordIns = ZBiginRecord.GetInstance("Contacts", 3372164000000614001);//module api name with record id
APIResponse response = recordIns.UploadAttachment("/Users/Bob/Desktop/testreport/report-dec-18.htm");
ZBiginAttachment uploadAttachment = (ZBiginAttachment)response.Data;
Copiedphoto = invokeUrl
[
	url: "https://pbs.twimg.com/text.txt"
	type: GET
];
photo.setParamName("file");
response = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/Contacts/1000000231009/Attachments"
	type: POST
	files: text file
	connection:"bigin_oauth_connection"
];

Possible Errors

  • 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.CREATE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

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

  • INVALID_DATAHTTP 400

    the related id given seems to be invalid
    Resolution: The related record ID specified in the URL is invalid. Refer to Get Related Records API to get valid related record IDs.

Sample Response

Copied{
    "data": [
       {
            "code": "SUCCESS",
            "details": {
                "id": "1000000231009"
            },
            "message": "attachment uploaded successfully",
            "status": "success"
        }
    ]
}