Edit a Job Sheet Record

Purpose

All the job sheet forms associated with the services added to a service appointment will be listed as job sheet records under the Job sheets tab of service appointments. Use this API to edit a specific job sheet record that is in the Draft or Completed status.

Request URL

https://fsm.zoho.com/fsm/v1/Job_Sheets

Request Method

PUT

Scope

scope=ZohoFSM.modules.JobSheets.UPDATE

Input JSON Keys

Name	Description	Type	Mandatory
id	The ID of the job sheet record you want to edit. You can obtain this ID from the Get Job Sheet Records by Service Appointment API.	String	Yes
Editing a subform
<subform_api_name>	You can obtain the api name of the subform from the Get a Job Sheet Record API. Provide a JSON array containing the subform entries you want to add or update. If an entry includes its id, that entry will be updated; if the id is not provided, a new entry will be created. You can obtain this id from the Get a Job Sheet Record API. Refer to the Sample Input for guidance. To delete a subform entry, include the key $fsm_delete in that entry and set it to true.	JSON Array

Sample Request

Copiedcurl --request PUT 'https://fsm.zoho.com/fsm/v1/Job_Sheets' \
--header 'Authorization: Zoho-oauthtoken 1000.26xxxxxxxxxx.xxxxxxxxxx0' \
--header 'content-type: application/json' \
--data "{"field1":"value1","field2":"value2"}"

Sample Input

Copied {
    "data": [
        {
            "id": "1003000002621276",
            "Description": "Testing",
            "New_Subform_9":[
            {
                "id":"7778000000466069",
                "Component_Name__C": "Air Filter"
             },
            {
                "Component_Name__C": "Fan",
                "Condition__C": "Good"
             }
          ]
        }
    ]
}

Sample Success Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2025-05-08T15:57:18+05:30",
                "Modified_By": {
                    "name": "Marianne Sheehan",
                    "id": "1003000000208001"
                },
                "Created_Time": "2025-05-08T15:49:13+05:30",
                "id": "1003000002621276",
                "Created_By": {
                    "name": "Marianne Sheehan",
                    "id": "1003000000208001"
                }
            },
            "message": "record updated",
            "status": "success"
        }
    ]
}

Sample Failure Response

Copied//If you provide an incorrect value for the field
{
    "data": [
        {
            "code": "INVALID_DATA",
            "details": {
                "api_name": "Main_Water_Valve_Status__C",
                "value": "Partially"
            },
            "message": "The radio choice provided is not valid.",
            "status": "error"
        }
    ]
}

Sample Failure Response

Copied//If the ID provided of the job sheet line item you want to edit is incorrect
{
    "data": [
        {
            "code": "INVALID_DATA",
            "details": {},
            "message": "the id given seems to be invalid",
            "status": "error"
        }
    ]
}