Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Layouts API

The Layouts API from Zoho — 1 operation(s) for layouts.

Zoho Layouts API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Layouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 1 operation across 1 path, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

1 operations 1 paths 15 schemas 1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho Layouts API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Layouts 1
PATCH
/settings/layouts/{id}
Update a Layout
updateLayout 2 params body → 200400401403405500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are SectionUpdateObject (8 properties), ErrorDetails (7 properties), FieldUpdateObject (6 properties), UpdateLayoutErrorResponse (5 properties). Each schema is shown below with its type and property counts.

UpdateLayoutErrorResponse
object
Error response for layout update operation.
5 properties
ProfileUpdateObject
object
Profile object for adding or removing profile permissions.
2 properties 1 required
ModuleName
string
Module API name
ErrorResponse
object
Standard error response structure
4 properties 4 required
UpdateLayoutRequest
object
Request body for updating a layout. Only a single layout can be updated per request.
1 property 1 required
LayoutUpdateErrorResult
object
Error result for a layout update.
4 properties 4 required
DeleteObject
object
Delete configuration object.
1 property 1 required
LayoutUpdateSuccessResult
object
Success result for a layout update.
4 properties 4 required
FieldUpdateObject
object
Field object for adding, updating, creating, or removing fields from a section. For adding an existing field, provide only id. For updating field position, pro…
6 properties
ErrorDetails
object
Additional context-specific error details. Properties vary based on error type.
7 properties
UpdateLayoutSuccessResponse
object
Successful response for layout update operation.
1 property 1 required
SectionUpdateObject
object
Section object for creating, updating, or deleting sections. For creating a new section, provide name, displaylabel, sequencenumber, tabtraversal, and columnco…
8 properties
Id
string
Unique identifier (64-bit integer represented as string)
LayoutUpdateErrorDetails
object
Error details specific to layout update operations.
5 properties
LayoutUpdateObject
object
Layout object containing the fields to update. At least one property must be provided. Maximum 5 sections and 5 fields (total across all sections) can be modif…
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-layouts-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ