Perform a Request Transition

Purpose

To perform a transition on a request. The transitions that are supported for a request are:

Cancel, Terminate

Request URL

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

record_id - The unique ID of the record. You can obtain this ID from the List Requests API.

Request Method

PUT

Scope

scope=ZohoFSM.modules.Requests.UPDATE

Input JSON Keys

Name

Description

Type

Mandatory

transition_id

The ID of the transition you want to perform on the request. It can be obtained from the record using the List Request Transitions API.

String

Yes

data

Use this to add notes while canceling or terminating a request.

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

Map

Mandatory when canceling or terminating a request.

Sample Request

Copiedcurl --request PUT 'https://fsm.zoho.com/fsm/v1/Requests/4776000000265108/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": "1439000000214132",
            "data": {
                "Notes": "Duplicate request"
            }
        }
    ]
}

Sample Response

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