Upload File

This API updates a file to a file upload, image, audio, video, or signature field of a specific record, which is present in a Zoho Creator application.

  • Refer to this section for the file types that these fields accept
  • The upload operation will be subject to the custom data validations configured for the corresponding form
  • The file you upload will be counted towards the file storage limit of the the account in which the target application exists. Visit the account's usage details page to view its current storage details.

Request URL

https://<base_url>/api/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>/<field_link_name>/upload

Request method

POST

Header

KeyValueDescription
AuthorizationZoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfAn authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.
environmentdevelopment/stageRefers to the environment stage.
Note: By default, production value will be considered for the environment header.

OAuth scope

scope=ZohoCreator.report.CREATE

where,

base_urlthe base URL of your Creator account
For example, it's creator.zoho.com if your account belongs to Zoho's US DC, and is creator.zoho.eu if it belongs to Zoho's EU DC.
account_owner_namethe username of the Creator account's owner
app_link_namethe link name of the target application
report_link_namethe link name of the target report
record_IDthe ID of the record that you want to upload the file
field_link_namethe link name of the target file upload, image, audio, video, or signature field
File types and limits
Possible Errors

Refer to this page for the list of error codes and messages.

Sample Request for Production environment

Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/upload"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

This sample request uploads a file to the Product_Manual field of the record with ID 3888834000000114050, which is displayed in the Inventory Report of the Zylker Store application.

Sample Request for Development/ Stage environments

Copiedcurl "https://creator.zoho.com/api/v2/jason18/c6/sections"
-X GET 
-H 'Authorization: Zoho-oauthtoken 1000.f8a33d38b8184db27d71796f4b883809.881b08a04bdaf09adfcf343ae491c7d0'  
-H 'environment: development'

Sample Input (multipart/form-data)

Copied{
  "file": "target_file_path"
}

Sample Response

Copied{
  "code": 3000,
  "filename": "Screen Shot 2019-12-20 at 10.56.27 AM.png",
  "filepath": "1580987985461_Screen_Shot_2019-12-20_at_10.56.27_AM.png",
  "message": "File uploaded successfully !"
}