Zoho

Zoho LayoutRules API

The LayoutRules API from Zoho — 3 operation(s) for layoutrules.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/
📖
GettingStarted
https://www.zoho.com/crm/developer/docs/
📖
Documentation
https://desk.zoho.com/DeskAPIDocument
📖
Documentation
https://www.zoho.com/analytics/api/v2/introduction.html
📖
APIReference
https://www.zoho.com/analytics/api/v2/
📖
Documentation
https://www.bigin.com/developer/docs/apis/v2/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-layoutrules-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-Sample-apps-iOS
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-android
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-flutter
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-reactnative
💻
CodeExamples
https://github.com/zoho/Zoho-Desk-ASAP-Mobile-SDK-API-Samples
💻
CodeExamples
https://github.com/zoho/analytics-codestudio

Other Resources

🔗
SDKs
https://packagist.org/packages/zohocrm/php-sdk-8.0
🔗
SDKs
https://pypi.org/project/zohocrmsdk8-0/
🔗
SDKs
https://www.nuget.org/packages/ZOHOCRMSDK-8.0/
🔗
SDKs
https://github.com/zoho/zohocrm-java-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/nodejs-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/typescript-sdk-8.0
🔗
SDKs
https://rubygems.org/gems/ZOHOCRMSDK8_0
🔗
SDKs
https://github.com/zoho/zohocrm-javascript-sdk-8.0
🔗
SDKs
https://github.com/zoho/zohocrm-scala-sdk-8.0
🔗
SDKs
https://cocoapods.org/pods/ZCRMiOS
🔗
DeveloperPortal
https://www.zoho.com/desk/developers/
🔗
SDKs
https://github.com/zoho/ZohoDeskPortalSDK
🔗
SDKs
https://github.com/zoho/react-native-zohodesk-portal-sdk
🔗
SDKs
https://github.com/zoho/zdesk-asap-flutter
🔗
SDKs
https://github.com/zoho/cordova-plugin-zohodesk-portal
🔗
Tools
https://github.com/zoho/analytics-mcp-server
🔗
Integrations
https://github.com/zoho/analytics-dataiku-import-plugin
🔗
Integrations
https://github.com/zoho/analytics-dataiku-export-plugin
🔗
DeveloperPortal
https://www.bigin.com/developer-center.html

OpenAPI Specification

zoho-layoutrules-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Helpcenter LayoutRules API
  version: 1.0.0
tags:
- name: LayoutRules
paths:
  /api/v1/layouts/{layoutId}/layoutRules/{layoutRuleId}:
    get:
      tags:
      - LayoutRules
      summary: Get Layout Rule
      description: This API fetches a single rule from your help desk layout.
      operationId: getLayoutRule
      parameters:
      - $ref: '#/components/parameters/layoutRuleId'
      - $ref: '#/components/parameters/layoutId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: '#/components/responses/layoutrulejson'
      security:
      - iam-oauth2-schema:
        - Desk.settings.READ
      x-audience:
      - external-public
    delete:
      tags:
      - LayoutRules
      summary: Delete Layout Rule
      description: This API deletes a layout rule created for a field from a layout.
      operationId: deleteLayoutRule
      parameters:
      - $ref: '#/components/parameters/layoutRuleId'
      - $ref: '#/components/parameters/layoutId'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '200':
          $ref: ./Common.json#/components/responses/emptyResponse
      security:
      - iam-oauth2-schema:
        - Desk.settings.DELETE
      x-audience:
      - external-public
    patch:
      tags:
      - LayoutRules
      summary: Update Layout Rule
      description: This API updates the details of an existing layout rule in a particular layout.
      operationId: updateLayoutRule
      parameters:
      - $ref: '#/components/parameters/layoutRuleId'
      - $ref: '#/components/parameters/layoutId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/editLayoutRule_layoutrulejsonPayload'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '200':
          $ref: '#/components/responses/layoutrulejson'
      security:
      - iam-oauth2-schema:
        - Desk.settings.UPDATE
      x-audience:
      - external-public
  /api/v1/layouts/{layoutId}/layoutRules:
    post:
      tags:
      - LayoutRules
      summary: Create Layout Rule
      description: This API creates a rule for a field in a layout.
      operationId: createLayoutRule
      parameters:
      - $ref: '#/components/parameters/layoutId'
      - $ref: ./Common.json#/components/parameters/orgId
      requestBody:
        $ref: '#/components/requestBodies/layoutrulejsonPayload'
      responses:
        '422':
          $ref: ./Common.json#/components/responses/invalidDataErrorResponse
        '200':
          $ref: '#/components/responses/layoutrulejson'
      security:
      - iam-oauth2-schema:
        - Desk.settings.CREATE
      x-audience:
      - external-public
  /api/v1/layoutRules:
    get:
      tags:
      - LayoutRules
      summary: Get Layout Rules
      description: This API lists all the rules configured for a department/layout.
      operationId: getLayoutRules
      parameters:
      - $ref: '#/components/parameters/searchString'
      - $ref: '#/components/parameters/executeInHelpCentre'
      - name: departmentId
        in: query
        description: Get the rules of the department
        required: true
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int64
          description: Get the rules of the department
          pattern: ([0-9]+)
      - name: module
        in: query
        description: Name of the module for which you want to fetch the layout rules. Allowed values are tickets, contacts, accounts, tasks, timeEntry, contracts, products, calls, events
        required: true
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          description: Name of the module for which you want to fetch the layout rules. Allowed values are tickets, contacts, accounts, tasks, timeEntry, contracts, products, calls, events
          enum:
          - tickets
          - contacts
          - accounts
          - tasks
          - calls
          - events
          - timeEntry
          - products
          maxLength: 100
          minLength: 0
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/from'
      - $ref: '#/components/parameters/layoutId'
      - name: activeRules
        in: query
        description: Get the rules that are active in the layout
        required: false
        style: form
        explode: true
        schema:
          type:
          - boolean
          - 'null'
          description: Get the rules that are active in the layout
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '200':
          $ref: '#/components/responses/layoutRuleListArray'
      security:
      - iam-oauth2-schema:
        - Desk.settings.READ
      x-audience:
      - external-public
components:
  parameters:
    from:
      name: from
      in: query
      description: Index number, starting from which the rules must be fetched
      required: false
      style: form
      explode: true
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int32
        description: Index number, starting from which the rules must be fetched
        pattern: ([0-9]+)
    searchString:
      name: searchString
      in: query
      description: Get the rules that have this search term
      required: false
      style: form
      explode: true
      schema:
        type:
        - string
        - 'null'
        description: Get the rules that have this search term
        maxLength: 100
        minLength: 0
    layoutId:
      name: layoutId
      in: path
      description: Get the rules of the layout
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        description: Get the rules of the layout
        pattern: ([0-9]+)
    layoutRuleId:
      name: layoutRuleId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
    executeInHelpCentre:
      name: executeInHelpCentre
      in: query
      description: Get the rules that can be executed in help centre
      required: false
      style: form
      explode: true
      schema:
        type:
        - boolean
        - 'null'
        description: Get the rules that can be executed in help centre
    limit:
      name: limit
      in: query
      description: Number of rules to be fetched. Default is 50
      required: false
      style: form
      explode: true
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int32
        description: Number of rules to be fetched. Default is 50
        pattern: ([0-9]+)
  requestBodies:
    layoutrulejsonPayload:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              displayLabel:
                type:
                - string
                - 'null'
                maxLength: 200
                minLength: 0
                pattern: ([0-9a-zA-Z_\-\.\$@\?\,\:\'\/\!\P{InBasicLatin}\s])+
              modifiedTime:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
              fieldConditions:
                $ref: ./LayoutRules.json#/components/schemas/fieldConditionsArr
              fieldName:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: ([0-9a-zA-Z_\-\.\$@\?\,\:\'\/\!\P{InBasicLatin}\s])+
              description:
                type:
                - string
                - 'null'
                maxLength: 65535
                minLength: 0
              systemGenerated:
                type:
                - boolean
                - 'null'
              layoutId:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              executeInHelpCentre:
                type:
                - boolean
                - 'null'
              createdBy:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              name:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
              createdTime:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
              modifiedBy:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              status:
                type:
                - string
                - 'null'
                enum:
                - active
                - deactive
                maxLength: 100
                minLength: 0
            required:
            - description
            - fieldConditions
            - fieldName
            - layoutId
            - name
          examples:
            Valid requestBody Definitions:
              value:
                fieldConditions:
                - name: condition 2
                  pattern: (1and2)
                  conditions:
                  - condition: is
                    fieldName: email
                    value:
                    - carol@zylker.com
                  - condition: is
                    fieldName: phone
                    value:
                    - '9993292892'
                  actions:
                    showSections:
                    - Additional Information
                    showFields:
                    - subject
                    setMandatoryFields:
                    - priority
                fieldName: email
                executeInHelpCentre: true
                name: Rule 1
                description: Rule 1 for layout
    editLayoutRule_layoutrulejsonPayload:
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              displayLabel:
                type:
                - string
                - 'null'
                maxLength: 200
                minLength: 0
                pattern: ([0-9a-zA-Z_\-\.\$@\?\,\:\'\/\!\P{InBasicLatin}\s])+
              modifiedTime:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
              fieldConditions:
                $ref: ./LayoutRules.json#/components/schemas/fieldConditionsArr
              fieldName:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: ([0-9a-zA-Z_\-\.\$@\?\,\:\'\/\!\P{InBasicLatin}\s])+
              description:
                type:
                - string
                - 'null'
                maxLength: 65535
                minLength: 0
              systemGenerated:
                type:
                - boolean
                - 'null'
              layoutId:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              executeInHelpCentre:
                type:
                - boolean
                - 'null'
              createdBy:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              name:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
              createdTime:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
                pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
              modifiedBy:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              status:
                type:
                - string
                - 'null'
                enum:
                - active
                - deactive
                maxLength: 100
                minLength: 0
            required:
            - description
            - fieldConditions
            - fieldName
            - layoutId
            - name
          examples:
            Valid requestBody Definitions:
              value:
                fieldConditions:
                - name: condition 1
                  pattern: (1and2)or3
                  conditions:
                  - condition: is
                    fieldName: email
                    value:
                    - carol@zylker.com
                  - condition: is
                    fieldName: accountId
                    value:
                    - Ramkumar
                  - condition: is
                    fieldName: productId
                    value:
                    - Honda
                  actions:
                    showSections:
                    - Additional Information
                    showFields:
                    - subject
                    setMandatoryFields:
                    - priority
                - name: condition 2
                  pattern: 1 and (2 or 3)
                  conditions:
                  - condition: is
                    fieldName: email
                    value:
                    - carol@zylker.com
                  - condition: is
                    fieldName: accountId
                    value:
                    - Sundar
                  - condition: is
                    fieldName: productId
                    value:
                    - Maruthi
                  actions:
                    showSections: []
                    showFields:
                    - subject
                    setMandatoryFields:
                    - Description
                fieldName: email
                executeInHelpCentre: false
                name: Rule 11
                description: Rule 1 for layout
                layoutId: '4000000007723'
                status: active
  responses:
    layoutRuleListArray:
      description: layoutRuleListArray template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              data:
                $ref: ./LayoutRules.json#/components/schemas/data
            required:
            - data
          examples:
            Valid responses Definitions:
              value:
                data:
                - fieldConditions:
                  - name: condition 1
                    pattern: (1and2)
                    conditions:
                    - condition: is
                      fieldName: email
                      value:
                      - carol@zylker.com
                    - condition: is
                      fieldName: phone
                      value:
                      - '9993292892'
                    actions:
                      showSections:
                      - Additional Information
                      showFields:
                      - subject
                      setMandatoryFields:
                      - priority
                  modifiedTime: 1536887322000
                  fieldName: email
                  description: Rule 1 for layout
                  systemGenerated: false
                  layoutId: '4000000007723'
                  executeInHelpCentre: false
                  createdBy: '4000000015963'
                  name: Rule 1
                  createdTime: 1536887242000
                  modifiedBy: '4000000015963'
                  id: '4000000020001'
                  status: active
                - fieldConditions:
                  - name: condition 2
                    pattern: (1or2)
                    conditions:
                    - condition: is
                      fieldName: phone
                      value:
                      - '9993292892'
                    - condition: is
                      fieldName: email
                      value:
                      - carol@zylker.com
                    actions:
                      showSections:
                      - Additional Information
                      showFields:
                      - subject
                      setMandatoryFields:
                      - priority
                  modifiedTime: 1536887322000
                  fieldName: phone
                  description: Rule 2 for layout
                  systemGenerated: false
                  layoutId: '4000000007723'
                  executeInHelpCentre: false
                  createdBy: '4000000015963'
                  name: Rule 2
                  createdTime: 1536887242000
                  modifiedBy: '4000000015963'
                  id: '4000000021001'
                  status: active
    layoutrulejson:
      description: layoutrulejson template definitions
      content:
        application/json:
          schema:
            additionalProperties: false
            allOf:
            - $ref: ./LayoutRules.json#/components/schemas/layoutrulejsonPayload
            - type:
              - 'null'
              - object
              properties:
                id:
                  type:
                  - string
                  - 'null'
                  - integer
                  format: int64
                  pattern: ([0-9]+)
              required:
              - id
          examples:
            Valid responses Definitions:
              value:
                fieldConditions:
                - name: condition 1
                  pattern: (1and2)or3
                  conditions:
                  - condition: is
                    fieldName: email
                    value:
                    - carol@zylker.com
                  - condition: is
                    fieldName: accountId
                    value:
                    - Ramkumar
                  - condition: is
                    fieldName: productId
                    value:
                    - Honda
                  actions:
                    showSections:
                    - Additional Information
                    showFields:
                    - subject
                    setMandatoryFields:
                    - priority
                - name: condition 2
                  pattern: 1 and (2 or 3)
                  conditions:
                  - condition: is
                    fieldName: email
                    value:
                    - carol@zylker.com
                  - condition: is
                    fieldName: accountId
                    value:
                    - Sundar
                  - condition: is
                    fieldName: productId
                    value:
                    - Maruthi
                  actions:
                    showSections: []
                    showFields:
                    - subject
                    setMandatoryFields:
                    - Description
                modifiedTime: 1536887322000
                fieldName: email
                description: Rule 1 for layout
                systemGenerated: false
                layoutId: '4000000007723'
                executeInHelpCentre: false
                createdBy: '4000000015963'
                name: Rule 11
                createdTime: 1536887242000
                modifiedBy: '4000000015963'
                id: '4000000021001'
                status: active
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter