younifyd
Menu

Update custom views

Update custom views

PUT/settings/custom_views

Use it in a workflow

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

Request

Query parameters

modulestringrequired

Specify the API name of the module for which to manage Custom Views. Refer to the Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs.resource for valid values.

Request body

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

custom_viewsarray<object>

Specify the list of Custom Views to update in bulk. Each object must include the Custom View ID and the fields to update.

idstring (int64)required

Represents the unique ID of the Custom View to update.

namestring

Represents the name of the Custom View.

access_typestring

Represents the access type for the Custom View. Possible values: **shared** - The view is shared with selected users, roles, groups, or territories. **public** - The view is accessible to all users in the organization. **only_to_me** - The view is private and accessible only to the creator.

One ofsharedpubliconly_to_me

categorystring

Represents the category for the Custom View. Possible values: **public_views** - Views accessible to all users in the organization. **other_users_views** - Views created by other users in the organization. **shared_with_me** - Views shared with the current user. **created_by_me** - Views created by the current user.

One ofpublic_viewsother_users_viewsshared_with_mecreated_by_me

sort_byoneOf

Represents the field used to sort the records in the Custom View.

sort_orderoneOf

Represents the sort order applied to the records in the Custom View.

lockedboolean

Indicates whether the Custom View is locked. Possible values: **true** - The view is locked. **false** - The view is not locked.

favoritenull | integer

Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite.

criteriaoneOf

Represents the filter criteria of the Custom View

cross_filtersoneOf

Represents the cross-filter criteria of the Custom View

shared_toarray | null

Represents the list of users, roles, groups, or territories the Custom View is shared with.

fieldsarray<object>5 fields

Represents the list of fields included in the Custom View, each with display and pin configuration details.

json
{
  "custom_views": [
    {
      "id": "string",
      "name": "string",
      "access_type": "shared",
      "category": "public_views",
      "sort_by": null,
      "sort_order": null,
      "locked": false,
      "favorite": null,
      "criteria": null,
      "cross_filters": null,
      "shared_to": null,
      "fields": [
        {
          "api_name": "string",
          "id": "string",
          "_pin": false,
          "_width": 0,
          "_pin_order": 0
        }
      ]
    }
  ]
}

Response

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

custom_viewsarray<object>

Represents the list of Custom View update success items.

statusstringrequired

Represents the status of the update response. Possible values: **success** - The operation was successful.

One ofsuccess

codestringrequired

Represents the success code for the update operation. Possible values: **SUCCESS** - The Custom View update completed successfully.

One ofSUCCESS

messagestringrequired

Represents the success message for the update operation.

detailsobjectrequired1 fields

Represents the additional details for the successful update operation.

json
{
  "custom_views": [
    {
      "status": "success",
      "code": "SUCCESS",
      "message": "string",
      "details": {
        "id": "string"
      }
    }
  ]
}

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