Insert Records
Purpose
To add new entities to a module.
Request URL
https://workerly.zoho.com/workerly/v2/{module_api_name}
For timelogs: https://workerly.zoho.com/workerly/v2/{timesheets_module_api_name}/Timelogs
module_api_name - The API name of the module
Modules supported in Get List of Records are supported here.
To insert a single record, send only one JSON object in the input with the necessary keys and values.
Request Method
POST
Scope
scope=ZohoWorkerly.modules.all
(or)
scope=ZohoWorkerly.modules.{module_name}.{operation_type}
| Possible module names | Possible operation types | |
|---|---|---|
| ALL - Full access to the record WRITE - Edit records in the module CREATE - Create records in the module |
Note:
An error is thrown if the field value length is more than the maximum length defined for that field.
If an API is used inside a Function and the field value length exceeds the limit, then that function receives an error response from the API. For example: If the max length for a "Text field" is defined as 10, then the value given for it in API cannot be "12345678901", as it has 11 characters.
Duplicates are checked for every insert record API call based on unique fields.
A maximum of 100 records can be inserted per API call.
The trigger input can be workflow, approval, or blueprint. If "trigger" is not mentioned, the workflows, approvals, and blueprints related to the API will get executed. Enter the trigger value as [] to not execute the workflows.
$approved key is used to set the records to be created in approval mode. It is mostly used for candidates and contacts procured from web forms.
Sample Attributes
The following table gives you specific details about each field type in Zoho Workerly and their limitations.
JSON type - Tells in what format the field should be passed in request-body or will be received in response.
Data type - Tells the type of data that can be stored in the corresponding field-type. It is mentioned below each Attribute.
| Attribute | JSON Type | Limitations | Sample |
|---|---|---|---|
| Single Line Text | String | Accepts up to 255 characters. Accepts alphanumeric and special characters. | "Last_Name": "Mike O'Leary", |
| Multi-Line Textarea | String | Small - accepts up to 2000 characters. Large - accepts up to 32000 characters. You will not be able to use this field to create custom views, reports, or other filters. Accepts alphanumeric and special characters. | "Multi_Line_1": "This is the first line \n Now for the second Line", |
| Email | String | Accepts valid email IDs. | "Email_1": "p.boyle@zylker.com", |
| Phone Phone | String | Accepts up to 30 characters. This limit may vary based on the value configured in 'Number of characters allowed' in the properties pop-up of the field, in UI. Accepts only numeric characters and '+' (to add extensions). The regex pattern in Zoho Workerly to validate this field's value is "[0-9a-zA-Z!#;%\\*\\^\\(\\)=\\{\\}\\[\\]\\?`~_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\|\\\\\\s\\+]+" | "Phone_1": "9900000000", |
| Picklist Picklist | String | You can either pass an existing picklist value or add a new one. The picklist value accepts all alphanumeric and special characters. | "Industry": "automobile" |
| Multi-Select Picklist Multi-select Picklist | JSON array | You can either pass existing picklist values or add a new one. The picklist value accepts all alphanumeric and special characters. | "Courses_Opted": [ "Analytics", "Big data" ], |
| Date Date in ISO 8601 format | String | Accepts date in yyyy-MM-dd format | "Date_1": "2017-08-16", |
| Date/time DateTime in ISO 8601 format | String | Accepts date and time in yyyy-MM-ddTHH:mm:ss±HH:mm ISO 8601 format | "Date_Time": "2017-08-16T14:32:23+05:30", Date_Time is in ISO8601 format and the time zone is the current user's time zone. |
| Number Integer | Integer | Accepts numbers up to 9 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI. Accepts only numeric values. | "No_of_Employees": 350, |
| Currency Currency | Double | Before decimal point - accepts numbers up to 16 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI. After decimal point - accepts precision up to 9 digits. This limit may vary based on the value configured in 'Number of decimal paces' in the properties pop-up of the field, in UI. Accepts only numeric values. | "Annual_Revenue": 250000.90, |
| Decimal Double | Double | Before decimal point - accepts numbers up to 16 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI. After decimal point - accepts precision up to 9 digits. This limit may vary based on the value configured in 'Number of decimal places' in the properties pop-up of the field, in UI. Accepts only numeric values. | "Decimal_1": 250000.50, |
| Percent Double | Double | Accepts numbers up to 5 digits. Accepts only numeric values. | "Percentage": 25, |
| Long Integer BigInt | String | Accepts numbers up to 18 digits. This limit may vary based on the value configured in 'Maximum digits allowed' in the properties pop-up of the field, in UI. Accepts only numeric values. | "EAN_Code":"0012345600012", |
| Checkbox Boolean | Boolean | Accepts only Boolean values(true,false). | "Email_Opt_Out": true, |
| URL Website | String | Accepts valid URLs. The regex pattern in Zoho Workerly to validate this field's value is "^(http:\\/\\/www.|https:\\/\\/www.|ftp:\\/\\/www.|www.|http:\\/\\/|https:\\/\\/|ftp:\\/\\/|){1}[^\\x00-\\x19\\x22-\\x27\\x2A-\\x2C\\x2E-\\x2F\\x3A-\\x40\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+(\\.[^\\x00-\\x19\\x22\\x24-\\x2C\\x2E-\\x2F\\x3C\\x3E\\x40\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+)+(\\/[^\\x00-\\x19\\x22\\x3C\\x3E\\x5E\\x7B\\x7D-\\x7D\\x7F]*)*$" | "URL": "https://www.zylker.com", |
| Lookup Lookup | JSON object | Accepts valid name and unique ID of the record, which you can get through meta data API. | "Lookup" : { "name" : "James", "id" : "425248000000104001" }, |
| Multi-select lookup Multi-Select Lookup | JSON array | Accepts valid record names and unique IDs. | "Accounts":[ { "Account_Name":"Zylker1", "id":"4150868000000420069" }, { "Account_Name":"Zylker", "id":"4150868000000420046" } ] |
| User User Lookup | JSON object | This is a default look-up field to users in Zoho Workerly. | "User": { "name":"Patricia Boyle", "id":"4150868000000623001" } |
Possible Errors
| HTTP Status | Error Code | Message | Reason | "Details" Key Values |
|---|---|---|---|---|
| 400 | INVALID_MODULE | The module name given is invalid | Invalid module name or no tab permission, or the module could have been removed from the organized module | --- |
| 400 | INVALID_MODULE | The given module is not supported in API | The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are supported.) | --- |
| 403 | NO_PERMISSION | permission denied to create '{modulename}' | No permission to insert records | --- |
| 400 | MANDATORY_NOT_FOUND | Required field not found. | If the data key isn't available | { "api_name": "data" } |
| 400 | INVALID_DATA | Invalid Data | If the data key has the invalid data type | { "expected_data_type":"jsonarray", "api_name": "data" }, |
| 202 | INVALID_DATA (at the record index) | Invalid Data | If the record passed isn't a JSON object | { "expected_data_type":"jsonobject", "index": 0 } |
| 202 | MANDATORY_NOT_FOUND | Required field not found | If the mandatory fields are not available | { "api_name":"Last_Name" } |
| 202 | INVALID_DATA | Invalid Data | If the data type is mismatched | { "expected_data_type":"double", "api_name":"Decimal_1" } |
Sample Request- Create Client
Copied
Sample Input- Create Clients
Copied
Show full
Show less
Sample Request- Create Temps
Copied
Sample Input- Create Temps
Copied
Show full
Show less
Sample Response- Create Temps
Copied
Show full
Show less
Sample Request- Create Jobs
Copied
Sample Input- Create Jobs
Copied
Show full
Show less
Sample Request- Timelogs
Copied
Sample Input- Timelogs
Copied
Show full
Show less