Update a custom layout

PATCH/settings/layouts/{id}

Use it in a workflow

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

Request

Path parameters

idstring (int64)required

Specify the unique identifier of the layout. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.

Query parameters

modulestringrequired

Specify the API name of the required module. 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.

layoutsarray<object>required

Contains exactly one layout object defining the update operations to be applied, including sections, profiles, and display settings.

namestring

Represents the new display name for the layout. Must be unique within the module's layout configurations.

show_business_cardboolean

Specifies whether the business card view is enabled or disabled for this layout as part of the update.

profilesarray<object>2 fields

Contains the array of profile objects to be added to or removed from the layout's profile associations in this update operation.

sectionsarray<object>8 fields

Contains the array of section objects to be created, modified, or deleted as part of this layout update, defining the field and configuration changes within each section.

json

{
  "layouts": [
    {
      "name": "string",
      "show_business_card": false,
      "profiles": [
        {
          "id": "4832675000000850800",
          "_delete": false
        }
      ],
      "sections": [
        {
          "id": "4832675000000850800",
          "name": "string",
          "display_label": "string",
          "sequence_number": 0,
          "tab_traversal": "left_to_right",
          "column_count": 1,
          "fields": [
            {
              "id": null,
              "field_label": null,
              "data_type": null,
              "length": null,
              "sequence_number": null,
              "element_type": null,
              "lookup_field": null,
              "_delete": null,
              "association_details": null
            }
          ],
          "_delete": {
            "permanent": false
          }
        }
      ]
    }
  ]
}

Response

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

layoutsarray<object>

Contains the array of result entries for the layout update operation, each reporting the outcome for an individual layout.

codestringrequired

Represents the success code returned when the layout update operation completes without error.

One ofSUCCESS

detailsobjectrequired1 fields

Contains the identifying details of the layout that was successfully updated, such as its ID.

messagestringrequired

Contains a confirmation message indicating that the layout update operation completed successfully.

statusstringrequired

Indicates the outcome of the layout update operation. Possible values: `success` — the layout update completes successfully.

One ofsuccess

json

{
  "layouts": [
    {
      "code": "SUCCESS",
      "details": {
        "id": "4832675000000850800"
      },
      "message": "layout updated",
      "status": "success"
    }
  ]
}

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

Was this page helpful?