Schedule a Service Appointment

Purpose

To schedule a service appointment.

Request URL

https://fsm.zoho.com/fsm/v1/Service_Appointments/<record_id>/actions/blueprint

Request Method

PUT

Scope

scope=ZohoFSM.modules.serviceappointments.UPDATE

Mandatory Parameters

Name	Description	Type
transition_id	The ID for the transition Schedule that can be obtained from the record using the List Transitions API.	String
Service_Resource	Include the IDs (the id in the Service_Resources key present in the List Users API response) of the service resources you want to assign to the service appointment.	String

Name	Description	Type
Scheduled_Start_Date_Time	Any changes you want to make to the start date and time of the appointment. The value must be in the ISO format: YYYY-MM-DDThh:mm:ssTZD	DateTime
Scheduled_End_Date_Time	Any changes you want to make to the end date and time of the appointment. The value must be in the ISO format: YYYY-MM-DDThh:mm:ssTZD	DateTime
Lead	ID of the service resource you want to assign as the lead. If no lead information is provided, the first service resource from $Service_Resources will be assigned as the lead of service appointment.	String
$allow_overlapping	If the transaction setting Allow Overlapping Appointments is enabled With Warning, setting $allow_overlapping to true will create an overlapping appointment.	Boolean

Sample Request

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

Sample Input

Copied{
    "blueprint": [
        {
            "transition_id": "1003000000240054",
            "data": {
                "Scheduled_Start_Date_Time": "2022-06-07T11:16:15+05:30",
                "Scheduled_End_Date_Time": "2022-06-07T11:16:30+05:30",
                "$Service_Resources": [
                    "1003000000208159"
                    ]
            }
        }
    ]
}

Sample Response

Copied{
    "code": "SUCCESS",
    "debug": {
        "forward": {
            "status": "error"
        },
        "backward": {
            "data": [
                {
                    "is_successfull": true,
                    "rule_trigger": {
                        "module": "Service_Appointments",
                        "id": "1003000001639015"
                    },
                    "info": "No rule exists"
                }
            ]
        }
    },
    "details": {},
    "message": "Action executed successfully",
    "actions": {
        "before": {},
        "after": {}
    },
    "status": "success"
}