Upload a Photo

Purpose

To attach a photo to a record. You must include the photo 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}/photo

Supported module

Contacts, Companies, and Products

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Possible module names

contacts, companies, products

Possible operation types

ALL - Full access to images
WRITE - Edit photo data
CREATE - Create photo data

Input

  • filefile, mandatory

    Choose the photo you want to upload.

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/3000000038009/photo"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-F "file=@img1.png"
CopiedZBiginRecord record = ZBiginRecord.getInstance("Contacts", 975824386248l);//module apiname with record id
APIResponse response = record.uploadPhoto("ImagePath");
String requestStatus =response.getStatus();
Copiedtry{
$record=ZBiginRecord::getInstance(“Contacts”,”410405000001111007”);
$responseIns=$record->uploadPhoto($photoPath); // $photoPath - absolute path of the photo 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_photo(self):
        try:
            record = ZBiginRecord.get_instance('Contacts', 3719520000000326007)
            resp = record.upload_photo('/Users/Downloads/pic1.png')
            print(resp.status_code)
            print(resp.code)
            print(resp.message)
            print(resp.status)
        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", 3372164000001632020); //module apiname with record id
APIResponse response = recordIns.UploadPhoto("ImagePath");
JObject photo = response.ResponseJSON; //photo is JArra
Copiedphoto = invokeUrl
[
	url: "https://pbs.twimg.com/profile_images/1212572524128563200/w2ub-ATf_400x400.jpg"
	type: GET
];
photo.setParamName("file");
response = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/{module_api_name}/{record_id}/photo"
	type: POST
	files: photo
	connection:"bigin_oauth_connection"
];

In the request, "file=@img1.png" contains the sample input image.

Possible Errors

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name. Specify a valid module API name. Refer to the possible module names section above.

  • 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. Refer to the possible module names section above.

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

  • NO_PERMISSIONHTTP 403

    Permission denied to upload photo
    Resolution: The user does not have permission to upload photo. 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 photo
    Resolution: The user does not have the permission to upload photo. 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.

  • FILE_SIZE_MORE_THAN_ALLOWED_SIZEHTTP 415

    please check if the file size is in the correct range
    Resolution: The photo you are trying to upload either exceeds the allowed size(10 MB) or the allowed resolution(10 MP). Ensure that the photo being uploaded is within the prescribed range.

Sample Response

Copied{
    "message": "photo uploaded successfully",
    "details": {},
    "status": "success",
    "code": "SUCCESS"
}