Create a custom view

POST/settings/custom_views

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Create a custom view action (under Metadata).
Fill in the fields below, then reference the result from later steps as {{createACustomView.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>required

Specify the list of Custom Views to create.

namestringrequired

Represents the name of the Custom View.

access_typestringrequired

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

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.

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.

wrap_textboolean

Indicates whether text wrapping is enabled for the Custom View. Possible values: **true** - Text wrapping is enabled. **false** - Text wrapping is disabled.

fieldsarray<object>required5 fields

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

json

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

Response

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

custom_viewsarray<object>

Represents the list of Custom Views created successfully.

statusstringrequired

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

One ofsuccess

codestringrequired

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

One ofSUCCESS

detailsobjectrequired1 fields

Represents the ID details for a created or affected resource.

messagestringrequired

Represents the success message for the create operation.

json

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

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

Was this page helpful?