younifyd
Menu

Update a custom field

Update a custom field

PATCH/settings/fields/{fieldId}

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Update a custom field action (under Metadata).
  3. Fill in the fields below, then reference the result from later steps as {{updateACustomField.response.data}}.

Request

Path parameters

fieldIdstring (int64)required

Specify the unique ID of the custom field to update.

Query parameters

modulestringrequired

Specify the API name of the module for which you want to retrieve field data. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.

Request body

Enter the body as JSON in the step's Body field.

fieldsarray<object>

Specify the list of fields to update.

field_labelstring

Specify the unique display label of the field.

idstring (int64)

Id of the resource.

lengthinteger (int32)

Maximum number of characters allowed. Varies by data type.

profilesarray<object>2 fields

Specify the profiles to which the field is to be assigned.

uniqueoneOf
lookupobject1 fields

Specify the lookup field configuration.

pick_list_valuesarray<object>6 fields

Specify the picklist configuration.

global_picklistoneOf
sharing_propertiesobject2 fields

Specify the update sharing properties for user lookup fields.

history_tracking_enabledboolean

Specify whether history tracking is enabled for the field.

history_trackingobject3 fields

Specify the history tracking configuration.

formulaobject6 fields

Specify the details of the formula field, including the return type and the expression.

decimal_placenumber (int32)

The number of decimal places for the formula field. This is valid for double and currency return types. Possible values are from 0 to 9, both inclusive.

currencyobject2 fields

Currency Field Data.

rollup_summaryobject4 fields

Specify the rollup summary field configuration.

association_detailsoneOf
json
{
  "fields": [
    {
      "field_label": "Your Name",
      "id": "1385208000000973001",
      "length": 150,
      "profiles": [
        {
          "id": "1385208000000973001",
          "permission_type": "read_write"
        }
      ],
      "unique": null,
      "lookup": {
        "query_details": {
          "criteria": {
            "group": [
              null
            ],
            "group_operator": "AND"
          }
        }
      },
      "pick_list_values": [
        {
          "display_value": "EXT_VAL_1",
          "actual_value": "EXT_VAL_1",
          "reference_value": "EXT_VAL_1",
          "colour_code": "#FF5733",
          "id": "1385208000000973001",
          "_global_picklist_value": {
            "id": "1385208000000973001"
          }
        }
      ],
      "global_picklist": null,
      "sharing_properties": {
        "share_preference_enabled": false,
        "share_permission": "read-only"
      },
      "history_tracking_enabled": false,
      "history_tracking": {
        "related_list_name": "Field History",
        "duration_configuration": "time",
        "followed_fields": [
          {
            "api_name": "Status",
            "id": "2423488000000123457",
            "_delete": null
          }
        ]
      },
      "formula": {
        "expression": "Sqrt(Len(${Email}))",
        "return_type": "double",
        "sub_return_type": "small",
        "dynamic": true,
        "stop_compute_conditionally": true,
        "stop_compute_expression": "3>1"
      }
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{updateACustomField.response.data.<field>}}.

fieldsarray<object>

Represents the list of field update results for the single-field update operation, containing one entry.

codestringrequired

Represents the result code.

One ofSUCCESS

detailsobjectrequired1 fields

Represents the details of the created field.

messagestringrequired

Represents the result message.

statusstringrequired

Represents the status of the operation.

One ofsuccess

json
{
  "fields": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "111112000000067259"
      },
      "message": "field created",
      "status": "success"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.