Update Records

Purpose

To update existing entities in the 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/{record_id}

To update a specific record;
https://workerly.zoho.com/workerly/v2/{module_api_name}/{record_id}

module_api_name - The API name of the module
record_id - The unique Id of the record

Modules supported in Get List of Records are supported here.

Request Method

PUT

Scope

scope=ZohoWorkerly.modules.all
(or)
scope=ZohoWorkerly.modules.{module_name}.{operation_type}

Possible module names	Possible operation types
Temps, Jobs, Clients, Timesheets, Contacts, To-Dos Note: Additionally, the API supports activated marketplace extensions.	ALL - Full access to the record WRITE - Edit records in the module UPDATE - Update records in the module

Possible Errors

HTTP Status	Error Code	Message	Reason
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.)

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 error response from the API. For ex: If the max length for a "Text field" is defined as 10, then 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.
You must use only Field API names in the input. You can obtain the field API names from Fields metadata API (the value for the key “api_name” for every field).
The trigger input can be workflow, approval, or blueprint. If the 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.
Records with Subform details can also be updated to Workerly using the Records API.
$approved key is used to set the records to be created in approval mode. It is mostly used for leads and contacts procured from webforms.
If the update API calls for a record are from DRE(Functions), due to workflow triggered on the same record's create/update, workflow alone will not get executed, irrespective of the trigger param configuration.

Sample Attributes

The following table gives you specific details about each field type in Zoho Workerly and their limitations.
The JSON type and the data type of the field-types are extracted from fields meta data API.
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 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 pick list value or add a new one. The pick list value accepts all alphanumeric and special characters.	"Industry": "automobile"
Multi-Select Picklist Multi-select Picklist	JSON array	You can either pass existing pick list values or add a new one. The pick list 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_Temps": 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 places' 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" }

Sample Request- Update Job

Copiedhttps://workerly.zoho.com/workerly/v2/Jobs/15304000000121160

Sample Input- Update Job

Copied{
	"data":[

		{
			"Client_Name":{
				"id":"15304000000053306"
			},
			"Job_Name":"3333Agency Approval",
			"Client_Approver":{
				"id":"15304000000053414"
			},
			"Date":{
				"from":"2020-01-01",
				"to":"2020-01-31"
			},
			"All_Day":true,
			"No_of_Working_Hours":"15:00:00",
			"No_of_Required_Temps":10,
			"Job_Title":"Nurse",

			"Base_Pay_Rate_Per_Hour":"20",
			"Benefit_Cost_Per_Hour" : "5",
			"Margin_Cost_Per_Hour" : "5",
			"Margin_Category" : "Percentage",
			"Benefit_Category" : "Percentage"
		
		}
	],
    "trigger":[]

}

Sample Request- Update Client

Copiedhttps://workerly.zoho.com/workerly/v2/Clients/15304000000121160

Sample Input- Update Client

Copied{
	"data":[

		{
			"Client_Name":"Zylker Auto Approval1",
			"Industry" : "Communications",
			"Address_Information":[
				{
					"Address_Title" : "Zylker",
					"Zipcode" : "00000",
					"Street_Address" : "Memory lane",
					"City" : "Brentwood",
					"State" : "New York",
					"Country" : "United States",
					"Set_as_Billing_Address" : true
				},
				{
					"Address_Title" : "Zylker",
					"Zipcode" : "00000",
					"Street_Address" : "Memory lane",
					"City" : "Brentwood",
					"State" : "New York",
					"Country" : "United States",
					"Set_as_Billing_Address" : false
				},
					{
					"Address_Title" : "Zylker",
					"Zipcode" : "00000",
					"Street_Address" : "Memory lane",
					"City" : "Brentwood",
					"State" : "New York",
					"Country" : "United States",
					"Set_as_Billing_Address" : false
				}
			]
		}
	],
    "trigger":[]

}

Sample Request- Update Temp

Copiedhttps://workerly.zoho.com/workerly/v2/Temps/12276543234567

Sample Input- Update Temp

Copied{
	"data":[

		{
			"Last_Name" : "Amelia",
			"Email" : "amelia.burrows200@gmail.com",
			"Mobile_Country_Code" : "IN",
			"Mobile" : "0000000000",
			"Current_Title" : "Nurse",
			"Multi_Select_1" : [
				"Option 1"
			],
			"Source" : "Internal",
			"Date_1" : "2017-08-18",
			"Date_Time_1" : "2017-08-20T14:32:23+05:30"
		}
	],
    "trigger":[]
}

Sample Request- Update Timelogs

Copiedhttps://workerly.zoho.com/workerly/v2/Timesheets/Timelogs/2280000000245059

Sample Input- Update Timelogs

Copied{
	"data":[

		{
			"Job_Name" : {
				"id" : "2280000000245054"
			},
			"Temp_Name" : {
				"id" : "2280000000230013"	
			},
			"Log_Date" : "2020-06-08",	
			"Day_Charge_Type" : "fullday",
			"Notes" : "temp job for zylker"
		}
	],
    "trigger":[]

}