Associate Records with Integrated Service
Purpose
- To either link, or unlink a Zoho FSM record w.r.t a record in an integrated Zoho service
- To push a Zoho FSM record to an integrated Zoho service
Request URL
https://fsm.zoho.com/fsm/v1/<module_api_name>/<record_id>/actions/process_sync
module_api_name - The API name of the Zoho FSM module whose record you want to link/unlink/push
record_id - The unique ID of the Zoho FSM record you want to link/unlink/push
Request Method
POST
Scope
scope=ZohoFSM.modules.<module_name>.UPDATE
Parameters
Name | Data Type | Description | Mandatory |
sync_service | String | The Zoho service with whose record you want to link/unlink a Zoho FSM record or to which you want to push the Zoho FSM record. The admissible values are: - finance - zohocrm | Yes |
Input JSON Keys
Name | Data Type | Description | Mandatory |
integ_id | String | The ID of the Zoho service record to which you want to link/unlink the Zoho FSM record. If you want to link/unlink a Zoho FSM contact to a contact person in Zoho Books/Invoice, then you need to use the ID of the contact person. Refer to the Get a Contact API doc of Books/Invoice to obtain this ID. | Yes, if you are performing link/unlink |
sync_process | String | The action that you want to perform on the Zoho FSM record. The possible values are: - link - unlink - push | Yes |
integ_module | String | The module in the integrated Zoho service with which you want to link a Zoho FSM request, estimate, or work order. The possible values are: - Deals - Sales_Orders | Yes, if you are linking a Zoho FSM request, estimate, or work order record |
Supported FSM Modules
Module Name | API Name | Action Allowed | Integrated Zoho Service |
Contacts | Contacts | Link, Unlink, Push | Finance |
Companies | Companies | Link, Unlink, Push | Finance |
Service_And_Parts | Service_And_Parts | Link, Unlink, Push | Finance |
Requests | Requests | Link, Unlink | CRM |
Estimates | Estimates | Link, Unlink | CRM |
WorkOrders | Work_Orders | Link, Unlink | CRM |
Sample Request
Copied
Sample Input (Link record)
Copied
Sample Success Response (Link record)
Copied
Sample Error Response (Link record)
Copied
Sample Error Response (Link record)
Copied
Sample Error Response (Link record)
Copied
Sample Input (Unlink record)
Copied
Sample Success Response (Unlink record)
Copied
Sample Error Response (Unlink record)
Copied
Sample Input (Push record)
Copied
Sample Success Response (Push record)
Copied
Sample Error Response (Push record)
Copied
Sample Input (Link Work Order with Sales Orders)
Copied
Sample Input (Link Work Order with Deals)
Copied
Sample Success Response
Copied