Create a Request

Purpose

To insert a new request record.

Request URL

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

Request Method

POST

Scope

scope=ZohoFSM.modules.Requests.CREATE

Input JSON Keys

NameDescriptionType

Summary

(mandatory)

A summary for the requestString

Contact* 

(mandatory)

The ID of the contact for whom the request is being createdString

Company*

(mandatory)

The ID of the company for which the request is being createdString

Territory

(mandatory)

The ID of the territory where you want the request to be assigned

This field will be mandatory only if territories other than the default service territory have been added to your FSM organization.

String

Service_Address

(mandatory)

Specify the ID of the service address you want for the request

Example: "id": "1011000000208180"

JSON Object

Billing_Address

(mandatory)

Specify the ID of the business address you want for the request

Example: "id": "1011000000208179"

JSON Object

*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/Requests' \
-d "@newRequest.json" \
--header 'Authorization: Zoho-oauthtoken 1000.b3xxxxxxxxxxx.xxxxxxx13'

Sample Input

Copied{
    "data": [
        {
            "Summary": "Sample Request",
            "Priority": "Medium",
            "Due_Date": "2022-03-08",
            "Contact": "1011000000208173",
            "Company": "1011000000139165",
            "Email": "lucy.robins@zylker.com",
            "Phone": "111-111-1111",
            "Asset": null,
            "Territory": "1011000000139175",
            "Service_Address": {
                "id": "1011000000208180"
            },
            "Billing_Address": {
                "id": "1011000000208179"
            },
            "Preference": {
                "Preferred_Date_1": null,
                "Preferred_Date_2": null,
                "Preferred_Time": null,
                "Preference_Note": null
            },
            "Currency": "USD",
            "Exchange_Rate": "1.000000000"
        }
    ]
}

Sample Response

Copied{
    "result": "success",
    "code": "SUCCESS",
    "data": {
        "Requests": [
            {
                "UID": "Requests_0",
                "Modified_Time": "2022-03-07T22:07:51-08:00",
                "Modified_By": {
                    "name": "Daniel Warne",
                    "id": "1011000000139001"
                },
                "Created_Time": "2022-03-07T22:07:51-08:00",
                "id": "1011000000222285",
                "Created_By": {
                    "name": "Daniel Warne",
                    "id": "1011000000139001"
                },
                "TabName": "Requests"
            }
        ]
    },
    "status": "success"
}