Upload a profile photo

Add a profile photo to a particular record by uploading an image file using a multipart/form-data request.

Endpoints

POST /{module_api_name}/{record_id}/photo

Request URL

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

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
ZohoBigin.modules.{module_name}.ALL
ZohoBigin.modules.{module_name}.WRITE
ZohoBigin.modules.{module_name}.CREATE

In the above scope, replace {module_name} with the necessary module. The possible modules include contacts, accounts (companies in Bigin), and products.

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
Companies	Accounts
Products	Products

record_id stringOptional

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

Body parameters

file file Required

This parameter represents the image file to be uploaded. It should be included in the request body using the multipart/form-data encoding. Make sure to provide path of the image file and extension for proper file upload.

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/Contacts/2034020000000489033/photo" \
-X POST \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \
-F "file=@"/path-to-file/contact-profile.png""

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"
];

Response object

The response object includes details regarding success and status messages.

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. 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{
    "code": "SUCCESS",
    "details": {},
    "message": "photo uploaded successfully",
    "status": "success"
}