Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sCode
String sCreated_time
String sFile_id
String sMessage
String sStatus
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "POST"
Set ComPath Of hoReq To "/crm/v2.1/upload"
Set ComContentType Of hoReq To "multipart/form-data"
Get ComAddFileForUpload2 Of hoReq "file" " path to file" "application/octet-stream" To iSuccess
Send ComAddHeader To hoReq "X-CRM-ORG" "694902309"
Send ComAddHeader To hoReq "Expect" "100-continue"
Send ComAddHeader To hoReq "feature" "bulk-write"
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComSynchronousRequest Of hoHttp "content.zohoapis.com" 443 True vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "code": "FILE_UPLOAD_SUCCESS",
// "details": {
// "created_time": "2021-05-11T12:03:18+05:30",
// "file_id": "4150868000005353001"
// },
// "message": "file uploaded.",
// "status": "success"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "code" To sCode
Get ComStringOf Of hoJResp "details.created_time" To sCreated_time
Get ComStringOf Of hoJResp "details.file_id" To sFile_id
Get ComStringOf Of hoJResp "message" To sMessage
Get ComStringOf Of hoJResp "status" To sStatus
End_Procedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-CRM-ORG: 694902309"
-H "feature: bulk-write"
--form 'file=@"/path/to/file"'
https://content.zohoapis.com/crm/v2.1/upload
Postman Collection Item JSON
{
"name": "Upload File",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "POST",
"header": [
{
"key": "X-CRM-ORG",
"value": "694902309",
"type": "text"
},
{
"key": "feature",
"value": "bulk-write",
"type": "text"
},
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"type": "file",
"src": "/Users/sneha-9300/Desktop/SampleCsvFile.zip"
}
]
},
"url": {
"raw": "https://content.zohoapis.com/crm/v2.1/upload",
"protocol": "https",
"host": [
"content",
"zohoapis",
"com"
],
"path": [
"crm",
"v2.1",
"upload"
]
},
"description": "To upload a CSV file in ZIP format for bulk write API. The response contains the **file_id**. Use this ID while making the bulk write request."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-CRM-ORG",
"value": "694902309",
"type": "text"
},
{
"key": "feature",
"value": "bulk-write",
"type": "text"
},
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"type": "file",
"src": "/Users/sneha-9300/Desktop/SampleCsvFile.csv.zip"
}
]
},
"url": {
"raw": "https://content.zohoapis.com/crm/v2.1/upload",
"protocol": "https",
"host": [
"content",
"zohoapis",
"com"
],
"path": [
"crm",
"v2.1",
"upload"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 10 May 2021 23:33:18 PDT"
},
{
"key": "Last-Modified",
"value": "Mon, 10 May 2021 23:33:18 PDT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Connection",
"value": "Keep-Alive"
},
{
"key": "Server",
"value": "AWServer"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Request-Served-By",
"value": "US4"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Length",
"value": "163"
},
{
"key": "Expires",
"value": "1"
}
],
"cookie": [
],
"body": "{\n \"code\": \"FILE_UPLOAD_SUCCESS\",\n \"details\": {\n \"created_time\": \"2021-05-11T12:03:18+05:30\",\n \"file_id\": \"4150868000005353001\"\n },\n \"message\": \"file uploaded.\",\n \"status\": \"success\"\n}"
},
{
"name": "INVALID_FILE_FORMAT",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-CRM-ORG",
"value": "694902309",
"type": "text"
},
{
"key": "feature",
"value": "bulk-write",
"type": "text"
},
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"type": "file",
"src": "/Users/sneha-9300/Downloads/_Bulk Write.erb"
}
]
},
"url": {
"raw": "https://content.zohoapis.com/crm/v2.1/upload",
"protocol": "https",
"host": [
"content",
"zohoapis",
"com"
],
"path": [
"crm",
"v2.1",
"upload"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 10 May 2021 23:33:47 PDT"
},
{
"key": "Last-Modified",
"value": "Mon, 10 May 2021 23:33:47 PDT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Connection",
"value": "Keep-Alive"
},
{
"key": "Server",
"value": "AWServer"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Request-Served-By",
"value": "US4"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Length",
"value": "164"
},
{
"key": "Expires",
"value": "1"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_FILE_FORMAT\",\n \"details\": {\n \"created_time\": \"2021-05-11T12:03:47+05:30\"\n },\n \"message\": \"invalid file format. only zip format is supported\",\n \"status\": \"error\"\n}"
},
{
"name": "METHOD_NOT_ALLOWED",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "X-CRM-ORG",
"value": "694902309",
"type": "text"
},
{
"key": "feature",
"value": "bulk-write",
"type": "text"
},
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"type": "file",
"src": "/Users/sneha-9300/Downloads/_Bulk Write.erb"
}
]
},
"url": {
"raw": "https://content.zohoapis.com/crm/v2.1/upload",
"protocol": "https",
"host": [
"content",
"zohoapis",
"com"
],
"path": [
"crm",
"v2.1",
"upload"
]
}
},
"status": "Method Not AllowedDate: Mon May 10 23:34:25 PDT 2021",
"code": 405,
"_postman_previewlanguage": "plain",
"header": [
],
"cookie": [
],
"body": null
},
{
"name": "AUTHENTICATION FAILURE",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-CRM-ORG",
"value": "694902309",
"type": "text"
},
{
"key": "feature",
"value": "bulk-write",
"type": "text"
},
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"type": "file",
"src": "/Users/sneha-9300/Downloads/_Bulk Write.erb"
}
]
},
"url": {
"raw": "https://content.zohoapis.com/crm/v2.1/upload",
"protocol": "https",
"host": [
"content",
"zohoapis",
"com"
],
"path": [
"crm",
"v2.1",
"upload"
]
}
},
"status": "Unauthorized Error",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 10 May 2021 23:34:53 PDT"
},
{
"key": "Last-Modified",
"value": "Mon, 10 May 2021 23:34:53 PDT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Connection",
"value": "Keep-Alive"
},
{
"key": "Server",
"value": "AWServer"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Request-Served-By",
"value": "US4"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "1"
}
],
"cookie": [
],
"body": "{\n \"ERROR_MESSAGE\": \"Unauthorized Error\",\n \"ERROR_CODE\": 401\n}"
},
{
"name": "INVALID_OAUTHTOKEN",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "X-CRM-ORG",
"value": "694902309",
"type": "text"
},
{
"key": "feature",
"value": "bulk-write",
"type": "text"
},
{
"key": "",
"value": "",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"type": "file",
"src": "/Users/sneha-9300/Desktop/SampleCsvFile.zip"
}
]
},
"url": {
"raw": "https://content.zohoapis.com/crm/v2.1/upload",
"protocol": "https",
"host": [
"content",
"zohoapis",
"com"
],
"path": [
"crm",
"v2.1",
"upload"
]
}
},
"status": "INVALID_OAUTHTOKEN",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 13 May 2021 01:24:16 PDT"
},
{
"key": "Last-Modified",
"value": "Thu, 13 May 2021 01:24:16 PDT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Connection",
"value": "Keep-Alive"
},
{
"key": "Server",
"value": "AWServer"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Request-Served-By",
"value": "US4"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "1"
}
],
"cookie": [
],
"body": "{\n \"ERROR_MESSAGE\": \"INVALID_OAUTHTOKEN\",\n \"ERROR_CODE\": 401\n}"
}
]
}
