POST /crm/v6/settings/fields
This API endpoint allows you to create new fields in the Leads module of the CRM. It is an HTTP POST request to the following URL: {{api-domain}}/crm/v6/settings/fields?module=Leads.
The request should include the necessary parameters to create the new field. The response will contain information about the created field, including its unique identifier.
Here is an example response for this request:
{
"fields": [
{
"code": "SUCCESS",
"details": {
"id": "111116000000066291"
},
"message": "field created",
"status": "success"
}
]
}
The fields array in the response contains an object with the following properties:
code: Represents the status of the field creation. In this example, it is set to "SUCCESS".details: Contains additional details about the created field. Theidproperty represents the unique identifier of the field.message: Provides a message indicating the result of the field creation. In this case, it is set to "field created".status: Indicates the overall status of the field creation. In this example, it is set to "success".
Please note that the actual response may vary based on the specific parameters provided in the request.
Feel free to use this API endpoint to create new fields in the Leads module of the CRM.
Servers
- https://accounts.zoho.com
- {{accounts-domain}}
- https://www.zohoapis.com
- https://content.zohoapis.com
- {{zohoapis}}
- https://download-accl.zoho.com
- https://www.zohoapis.comcrm
- https://www.zohoapis.com
- https://https://www.zohoapis.com
- https://crm.localzoho.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
x-zoho-service |
String | No |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
include |
String | No | |
module |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
fields[] |
Array | No | |
fields[].data_type |
String | No | |
fields[].hipaa_compliance_enabled |
Boolean | No | |
fields[].tooltip |
Object | No | |
fields[].tooltip.name |
String | No | |
fields[].tooltip.value |
String | No | |
fields[].length |
Number | No | |
fields[].private |
Object | No | |
fields[].private.type |
String | No | |
fields[].crypt |
Object | No | |
fields[].crypt.mode |
String | No | |
fields[].field_label |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.