Stop a Trip

Purpose

To stop a trip.

Request URL

https://fsm.zoho.com/fsm/v1/Trips/end

Request Method

PUT

Scope

scope=ZohoFSM.modules.Trips.UPDATE

Input JSON Parameters

NameDescriptionType

Appointment

(mandatory)

The service appointment for which you want to create the trip. You can obtain this ID from the List Service Appointments API.String
Service_Resource
(mandatory)
The ID of the user for whom you want to create a time off. Use the id in the Service_Resources key present in the List Users API response.String

Or

id

(mandatory)

The ID of the trip you want to end. You can fetch this from the Related List API or List Trips API.String

Sample Request

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

Sample Input

Copied{
	"data": [
        {
            "Appointment": "1003000004283017",
            "Service_Resource": "1003000000208159"
        }
    ]
}

Sample Success Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2026-05-06T12:14:01+05:30",
                "Modified_By": {
                    "name": "Marianne Sheehan",
                    "id": "1003000000208001"
                },
                "Created_Time": "2026-05-06T12:10:53+05:30",
                "id": "1003000004509017",
                "Created_By": {
                    "name": "Marianne Sheehan",
                    "id": "1003000000208001"
                }
            },
            "message": "record updated",
            "status": "success"
        }
    ]
}

Sample Error Response

Copied{
    "code": "INVALID_DATA",
    "details": {},
    "message": "No active trip found for the given Appointment and Service_Resource",
    "status": "error"
}

Sample Error Response

Copied//A valid trip ID is not used
{
    "code": "INVALID_DATA",
    "details": {},
    "message": "Invalid Id",
    "status": "error"
}

Sample Error Response

Copied{
    "code": "NOT_ALLOWED",
    "details": {},
    "message": "Trip has already ended",
    "status": "error"
}