Terminate a Service Appointment

Purpose

To terminate 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 Terminate that can be obtained from the record using the List Transitions API.

String

data

Add the notes for terminating the service appointment

N.B. Error will be thrown if the user does not have the Notes -> Create permission.

Map

Sample Request

Copiedcurl --request PUT 'https://fsm.zoho.com/fsm/v1/Service_Appointments/2287000000425290/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": "2287000000169069",
            "data": {
                "Notes": "Customer not present at the location"
            }
        }
    ]
}

Sample Response

Copied{
    "code": "SUCCESS",
    "details": {},
    "message": "Action executed successfully",
    "actions": {
        "before": {},
        "after": {}
    },
    "status": "success"
}