younifyd
Menu

Delete a custom field

Delete a custom field

DELETE/settings/fields/{fieldId}

Use it in a workflow

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

Request

Path parameters

fieldIdstring (int64)required

Specify the unique ID of the custom field to delete.

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.

Response

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

fieldsarray<object>

Represents the list of field deletion results, containing one entry with the unique ID of the deleted field.

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.