Service Appointment APIs

A Service Appointment is a job created for carrying out the services in a work order.

Create a Service Appointment

Purpose

To insert a new service appointment record.

Request URL

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

Request Method

POST

Scope

scope=ZohoFSM.modules.ServiceAppointments.CREATE

Mandatory Parameters

Name	Description	Type
Summary	A summary for the service appointment	String
Scheduled_Start_Date_Time	The scheduled start date time for the appointment	String
Scheduled_End_Date_Time	The scheduled end date time for the appointment	String
$Service_Line_Items	Include the IDs of the service line items in a work order for which you want to create an appointment	Array

*This field will be mandatory depending on the sync type for the FSM-Invoice/Books integration

Sample Request

Copiedcurl --location --request POST 'https://fsm.zoho.com/fsm/v1/Service_Appointments' \
--header 'Authorization: Zoho-oauthtoken 1000.26xxxxxxxxxx.xxxxxxxxxx0' \
-d "@newSA.json"

Sample Input

Copied{
    "data": [
        {
            "Summary": "Sample",
            "Contact": "2287000000197011",
            "Company": "2287000000179310",
            "Asset": null,
            "Preference": {
                "Preferred_Time": null,
                "Preferred_Date_1": null,
                "Preferred_Date_2": null,
                "Preference_Note": null
            },
            "Due_Date": null,
            "Scheduled_Start_Date_Time": "2023-01-16T02:00:00+05:30",
            "Scheduled_End_Date_Time": "2023-01-16T03:00:00+05:30",
            "Territory": "2287000000179301",
            "Service_Address": {
                "id": "2287000000197019",
                "Service_Latitude": 41.729768,
                "Service_Longitude": -88.270393
            },
            "$Service_Tasks_Line_Items": [
                "2287000000257096",
                "2287000000257094"
            ],
            "$Service_Line_Items": [
                "2287000000257084"
            ],
            "Lead": "2287000000179289",
            "Status": "New",
            "$Service_Resources": [
                "2287000000179289"
            ]
        }
    ]
}

Sample Success Response

Copied{
    "result": "success",
    "code": "SUCCESS",
    "data": [
        {
            "UID": "Service_Appointments_0",
            "Modified_Time": "2023-01-03T12:16:59+05:30",
            "Modified_By": {
                "name": "William Turner",
                "id": "2287000000179001"
            },
            "Created_Time": "2023-01-03T12:16:59+05:30",
            "id": "2287000000258008",
            "Created_By": {
                "name": "William Turner",
                "id": "2287000000179001"
            },
            "TabName": "ServiceAppointments"
        }
    ],
    "status": "success"
}