Perform an API call in Zoho CRM
Performs an API call in Zoho
Application
- Zoho
Inputs (what you have)
| Name | Description | Data Type | Required? | Example |
|---|---|---|---|---|
| Endpoint | The URL of the API endpoint to access | Text (Long) | Yes | https://api.example.com/users |
| Method | The HTTP method to be used for the request | Predefined Choice List | Yes | GET |
| Request headers | Additional headers to include in the request in JSON format | Text (Long) | No | {"Content-Type": "application/json"} |
| Request body | The data to be included in the request body | Text (Long) | No | {"name": "John", "age": 25} |
| File | A file to be included in the request. Note: If a file is added, leave request headers blank and add a 'filename' in your request body. | File | No | example.png |
| Autopaginate | True/False | No | Whether to automatically retrieve and combine paginated results | |
| Max results | Integer | No | The maximum number of results to retrieve | |
| Results JSONPath | Text(Short) | No | The path to the results in the response body |
Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data library section. These variables in the Data library section are the outputs of previous Wrk Actions in the Wrkflow.
Outputs (what you get)
| Name | Data Type | Description | Required? | Example |
|---|---|---|---|---|
| Response status code | Integer | The HTTP status code returned in the response | Yes | 200 |
| Response headers | Text (Long) | Additional information provided in the response headers | No | Content-Type: application/json |
| Response body | Text (Long) | The main content of the response | No | {"message": "Success"} |
| Downloaded file | File | A file that is downloaded as part of the response | No | example.pdf |
Note: The "Fields to Capture" input feature can be used to create new outputs for the Wrk Action with the value of the corresponding key name in the first-level JSON output of the Wrk Action.
Outcomes
| Name | Description |
|---|---|
| Success | This status is selected in the event that the API call returns with a status between 200-399 |
| Unsuccessful | This status is selected in the event that the API call returns with a status of 400+ |
| Impossible to Complete | This status is selected in the event of the following scenario:Couldn't resolve hostnameThe external system is not accessible |
Requirements
- N/A