younifyd
Menu

Delete a custom layout

Delete a custom layout

DELETE/settings/layouts/{id}

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the Delete a custom layout action (under Metadata).
  3. Fill in the fields below, then reference the result from later steps as {{deleteACustomLayout.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.

transfer_tostring (int64)

Specify the ID of the layout to which records associated with the current layout move upon layout deletion or deactivation. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.

pipelinestring (int64)

Specify the ID of the pipeline to transfer records to when deleting or deactivating a layout. Refer to the [Get Pipelines](pipeline.yaml#$.paths./settings/pipeline.get) resource for valid values.

stagestring (int64)

Specify the ID of the stage within the pipeline to assign transferred records when deleting or deactivating a layout. Refer to the [Get Pipelines](pipeline.yaml#$.paths./settings/pipeline.get) resource for valid values.

Response

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

layoutsarray<object>

Contains one entry per layout included in the deletion request, each reporting the individual outcome — such as success or failure — for that specific layout.

codestringrequired

Indicates the outcome code returned for the layout deletion attempt. Possible values: `SUCCESS` — the layout deletion completes successfully.

One ofSUCCESS

detailsobjectrequired1 fields

Represents the identifying details of a layout that has been successfully deleted, returned in the deletion response to confirm which layout was removed.

messagestringrequired

Contains a descriptive message summarising the outcome of the layout deletion operation, providing context for both successful completions and failure conditions.

statusstringrequired

Represents the overall processing state of the layout deletion request. Possible values: `success` — the layout was removed as requested.

One ofsuccess

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

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