{
"callback": {
"method": "post"
},
"query": {
"module": {
"api_name": "Project_Details"
}
},
"file_type": "csv"
}
|
{
"query": {
"module": {
"api_name": "Project_Details"
},
"fields": [
"Project_Name",
"Project_Type",
"Expected_Budget",
"Status"
],
"criteria": {
"field": {
"api_name": "Expected_Budget"
},
"comparator": "greater_equal",
"value": "40000" //Retrieving subform records with an expected budget greater than or equal to $40,000
}
}
}
|
{
"callback": {
"method": "post"
},
"query": {
"module": {
"api_name": "EmpXSkills"
},
"fields": [
"Employees.Name",
"Employees.Year_of_Experience",
"Skills.Name"
],
"criteria": {
"group": [
{
"field": {
"api_name": "Employees.Year_of_Experience"
},
"comparator": "greater_than",
"value": "4"
},
{
"field": {
"api_name": "Skills.Name"
},
"comparator": "contains",
"value": "Social"
}
],
"group_operator": "AND"
}
}
}
|
{
"callback": {
"method": "post"
},
"query": {
"module": {
"api_name": "Appointments__s" //API name of the Appointments module
}
},
"file_type": "csv"
}
|
{
"callback": {
"method": "post"
},
"query": {
"module": {
"api_name": "Contacts"
},
"fields": [
"Last_Name",
"Owner",
"Lead_Source",
"Created_Time"
],
"criteria": {
"group_operator": "and",
"group": [
{
"field": {
"api_name": "Lead_Source"
},
"comparator": "equal",
"value": "Advertisement"
},
{
"field": {
"api_name": "Owner"
},
"comparator": "equal",
"value": "Boyle"
},
.
.
.
// Add more criteria objects here, up to 25 total
]
}
}
}
|
{
"callback": {
"method": "post"
},
"query": {
"module": {
"api_name": "Contacts"
},
"fields": [
"Last_Name",
"Owner",
"Owner.last_name",
"Account_Name.Account_Name", //account lookup field
"Account_Name.Phone",
"Lead_Source"
],
"criteria": {
"group_operator": "or",
"group": [
{
"field": {
"api_name": "Lead_Source"
},
"comparator": "equal",
"value": "Advertisement"
},
{
"field": {
"api_name": "Owner.last_name" //owner lookup field in the Contacts
},
"comparator": "equal",
"value": "Boyle"
},
{
"field": {
"api_name": "Account_Name.Phone" //account lookup field in the Contacts
},
"comparator": "contains",
"value": "99807"
}
]
}
}
}
|
{
"status": "error",
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource doesn't exist.",
"details": {
"resource": "5725767000006841003"
}
}
|
{
"data": [
{
"id": "3652397000000646004",
"operation": "read",
"state": "COMPLETED",
"result": {
"page": 1,
"per_page": 200000,
"count": 200000,
"download_url": "/crm/bulk/v8/read/2276164000001136017/result",
"more_records": true,
"next_page_token": "bca6fba106357ae3b1ecbd63f"
},
"query": {
"module": {
"id": "2276164000000000125",
"api_name": "Contacts"
},
"page": 1
},
"created_by": {
"id": "2276164000000471001",
"name": "Patricia"
},
"file_type": "csv"
}
]
}
|
{
"query": {
"page_token": "bca6fba106357ae3b1ecbd63f"
}
}
|
zip bulk_data.zip parent.csv -> zip test.zip test.csv
|
Header |
Value |
Authorization |
Zoho-oauthtoken {access_token} |
Content-Type |
multipart/form-data |
X-CRM-ORG {org_id} Use the Organization API to get your org ID. |
123456789 |
feature |
bulk-write |
Option 1: To reference by ID |
Option 2: To reference by a field value (like name) |
Use the format: field_api_name.id |
Use the format: field_api_name.field_api_name |
{
"api_name": "Lead_Source", // Picklist field
"index": 2, // Column index in the CSV
"default_value": { // Optional key with a default value
"value": "call"
}
}
|
{
"api_name": "Rating",
"default_value": {
"value": "A;B"
}
}
|
{
"api_name": "Registered_day",
"default_value": {
"value": "2025-03-21"
}
}
|
{
"api_name": "Decimal",
"default_value": {
"value": "99.75"
}
}
|