Zoho Services S API

The Services S API from Zoho — 2 operation(s) for services s.

Documentation

Specifications

Code Examples

Other Resources

OpenAPI Specification

zoho-services-s-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Helpcenter Services S API
  version: 1.0.0
tags:
- name: Services S
paths:
  /Services__s:
    get:
      summary: GET /services_s
      description: services records get
      operationId: getServicesS
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetservicessResponse200'
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponseCore1604218709'
                - $ref: '#/components/schemas/ErrorResponseCore1872678286'
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.services.READ
      tags:
      - Services S
    put:
      summary: PUT /services_s
      description: update services api
      operationId: putServicesS
      parameters:
      - $ref: '#/components/parameters/ParamQueryAffectedData'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutservicessRequest'
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutservicessResponse200'
        '207':
          description: Multi-Status — Response contains mixed status results
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                description: Wrapped response containing data
                properties:
                  data:
                    type: array
                    allOf:
                    - contains:
                        $ref: '#/components/schemas/Post207multistatusResponse207'
                      description: success response in data
                      minContains: 1
                    - contains:
                        $ref: '#/components/schemas/DataError'
                      description: error response in data
                      minContains: 1
                    description: Array of success or failure data items
                    items:
                      oneOf:
                      - $ref: '#/components/schemas/Post207multistatusResponse207'
                      - $ref: '#/components/schemas/DataError'
                    maxItems: 200
                    minItems: 2
                required:
                - data
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/DataError'
                - $ref: '#/components/schemas/ErrorResponseCore564845355'
                - $ref: '#/components/schemas/ErrorResponseCore1569170772'
                - $ref: '#/components/schemas/ErrorResponseCore197782636'
                - $ref: '#/components/schemas/ErrorResponseCore1225158361'
                - $ref: '#/components/schemas/ErrorResponseCore695778820'
                - $ref: '#/components/schemas/ErrorResponseCore775669499'
                - $ref: '#/components/schemas/ErrorResponseCore1835963120'
                - $ref: '#/components/schemas/ErrorResponseCore1173663876'
                - $ref: '#/components/schemas/ErrorResponseCore542688165'
                - $ref: '#/components/schemas/ErrorResponseCore1924753111'
                - $ref: '#/components/schemas/ErrorResponseCore531684933'
                - $ref: '#/components/schemas/ErrorResponseCore1335501272'
                - $ref: '#/components/schemas/ErrorResponseCore964180820'
                - $ref: '#/components/schemas/ErrorResponseCore1604071034'
                - $ref: '#/components/schemas/ErrorResponseCore1484615382'
                - type: object
                  additionalProperties: false
                  description: Wrapped error response with data
                  properties:
                    data:
                      type: array
                      description: Array of error objects
                      items:
                        oneOf:
                        - $ref: '#/components/schemas/ErrorResponseCore591812267'
                        - $ref: '#/components/schemas/ErrorResponseCore578559762'
                        - $ref: '#/components/schemas/DataError'
                      maxItems: 25
                  required:
                  - data
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.services.UPDATE
      tags:
      - Services S
    post:
      summary: POST /services_s
      description: create services api
      operationId: postServicesS
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostservicessRequest'
      responses:
        '201':
          description: Created - Resource created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostservicessResponse201'
        '207':
          description: Multi-Status — Response contains mixed status results
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                description: Wrapped response containing data
                properties:
                  data:
                    type: array
                    allOf:
                    - contains:
                        $ref: '#/components/schemas/Post207multistatusResponse207'
                      description: success response in data
                      minContains: 1
                    - contains:
                        $ref: '#/components/schemas/ErrorResponseCore1168955151'
                      description: error response in data
                      minContains: 1
                    description: Array of success or failure data items
                    items:
                      oneOf:
                      - $ref: '#/components/schemas/Post207multistatusResponse207'
                      - $ref: '#/components/schemas/ErrorResponseCore1168955151'
                    maxItems: 200
                    minItems: 2
                required:
                - data
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponseCore48783029'
                - $ref: '#/components/schemas/ErrorResponseCore564845355'
                - $ref: '#/components/schemas/ErrorResponseCore1569170772'
                - $ref: '#/components/schemas/ErrorResponseCore197782636'
                - $ref: '#/components/schemas/ErrorResponseCore815194988'
                - $ref: '#/components/schemas/ErrorResponseCore1915970813'
                - $ref: '#/components/schemas/ErrorResponseCore1225158361'
                - $ref: '#/components/schemas/ErrorResponseCore661033389'
                - $ref: '#/components/schemas/ErrorResponseCore695778820'
                - $ref: '#/components/schemas/ErrorResponseCore1805991557'
                - $ref: '#/components/schemas/ErrorResponseCore541683400'
                - $ref: '#/components/schemas/ErrorResponseCore775669499'
                - $ref: '#/components/schemas/ErrorResponseCore1835963120'
                - $ref: '#/components/schemas/ErrorResponseCore1173663876'
                - $ref: '#/components/schemas/ErrorResponseCore542688165'
                - $ref: '#/components/schemas/ErrorResponseCore1924753111'
                - $ref: '#/components/schemas/ErrorResponseCore531684933'
                - $ref: '#/components/schemas/ErrorResponseCore1335501272'
                - $ref: '#/components/schemas/ErrorResponseCore964180820'
                - $ref: '#/components/schemas/ErrorResponseCore2060249394'
                - $ref: '#/components/schemas/ErrorResponseCore1604071034'
                - $ref: '#/components/schemas/ErrorResponseCore1484615382'
                - $ref: '#/components/schemas/ErrorResponseCore416413920'
                - type: object
                  additionalProperties: false
                  description: Wrapped error response with data
                  properties:
                    data:
                      type: array
                      description: Array of error objects
                      items:
                        oneOf:
                        - $ref: '#/components/schemas/ErrorResponseCore591812267'
                        - $ref: '#/components/schemas/ErrorResponseCore578559762'
                        - $ref: '#/components/schemas/ErrorResponseCore1759680246'
                      maxItems: 25
                  required:
                  - data
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.services.CREATE
      tags:
      - Services S
    delete:
      summary: DELETE /services_s
      description: services records delete
      operationId: deleteServicesS
      parameters:
      - $ref: '#/components/parameters/ParamQueryIds'
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteservicessResponse200'
        '207':
          description: Multi-Status — Response contains mixed status results
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                description: Wrapped response containing data
                properties:
                  data:
                    type: array
                    allOf:
                    - contains:
                        $ref: '#/components/schemas/Post207multistatusResponse207'
                      description: success response in data
                      minContains: 1
                    - contains:
                        $ref: '#/components/schemas/ErrorResponseCore297287888'
                      description: error response in data
                      minContains: 1
                    description: Array of success or failure data items
                    items:
                      oneOf:
                      - $ref: '#/components/schemas/Post207multistatusResponse207'
                      - $ref: '#/components/schemas/ErrorResponseCore297287888'
                    maxItems: 200
                    minItems: 2
                required:
                - data
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponseCore1202290576'
                - $ref: '#/components/schemas/ErrorResponseCore1604218709'
                - $ref: '#/components/schemas/ErrorResponseCore980155013'
                - $ref: '#/components/schemas/DataError'
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.services.DELETE
      tags:
      - Services S
  /Services__s/{id}:
    get:
      summary: GET /services_s/{id}
      description: services record get by id
      operationId: getServiceById
      parameters:
      - $ref: '#/components/parameters/ParamPathId'
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetservicessResponse200'
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponseCore1604218709'
                - $ref: '#/components/schemas/ErrorResponseCore1872678286'
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.services.READ
      tags:
      - Services S
    put:
      summary: PUT /services_s/{id}
      description: update services api
      operationId: putServiceById
      parameters:
      - $ref: '#/components/parameters/ParamQueryAffectedData'
      - $ref: '#/components/parameters/ParamPathId'
      requestBody:
        description: Request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutservicessRequest'
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutservicessResponse200'
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/DataError'
                - $ref: '#/components/schemas/ErrorResponseCore564845355'
                - $ref: '#/components/schemas/ErrorResponseCore1569170772'
                - $ref: '#/components/schemas/ErrorResponseCore197782636'
                - $ref: '#/components/schemas/ErrorResponseCore1225158361'
                - $ref: '#/components/schemas/ErrorResponseCore695778820'
                - $ref: '#/components/schemas/ErrorResponseCore775669499'
                - $ref: '#/components/schemas/ErrorResponseCore1835963120'
                - $ref: '#/components/schemas/ErrorResponseCore1173663876'
                - $ref: '#/components/schemas/ErrorResponseCore542688165'
                - $ref: '#/components/schemas/ErrorResponseCore1924753111'
                - $ref: '#/components/schemas/ErrorResponseCore531684933'
                - $ref: '#/components/schemas/ErrorResponseCore1335501272'
                - $ref: '#/components/schemas/ErrorResponseCore964180820'
                - $ref: '#/components/schemas/ErrorResponseCore1604071034'
                - $ref: '#/components/schemas/ErrorResponseCore1484615382'
                - type: object
                  additionalProperties: false
                  description: Wrapped error response with data
                  properties:
                    data:
                      type: array
                      description: Array of error objects
                      items:
                        oneOf:
                        - $ref: '#/components/schemas/ErrorResponseCore591812267'
                        - $ref: '#/components/schemas/ErrorResponseCore578559762'
                      maxItems: 25
                  required:
                  - data
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.services.UPDATE
      tags:
      - Services S
    delete:
      summary: DELETE /services_s/{id}
      description: services record delete by id
      operationId: deleteServiceById
      parameters:
      - $ref: '#/components/parameters/ParamPathServiceId'
      responses:
        '200':
          description: OK - Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteservicessResponse200'
        '400':
          description: Bad Request - The request cannot be processed due to invalid syntax.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorResponseCore1202290576'
                - $ref: '#/components/schemas/ErrorResponseCore1604218709'
                - $ref: '#/components/schemas/ErrorResponseCore980155013'
                - $ref: '#/components/schemas/DataError'
      security:
      - iam-oauth2-schema:
        - ZohoCRM.modules.services.DELETE
      tags:
      - Services S
components:
  schemas:
    DataError:
      type: object
      description: Generated schema for dataError
      additionalProperties: true
      properties:
        code:
          description: error code
          maxLength: 255
          type: string
        details:
          type: object
          additionalProperties: false
          description: error details with validation information
          properties:
            api_name:
              description: name of the invalid field
              type: string
              maxLength: 255
            json_path:
              description: json path of the invalid field
              type: string
              maxLength: 1000
          required: []
        message:
          type: string
          description: error message
          maxLength: 1000
        status:
          description: status
          type: string
          maxLength: 1000
      required:
      - code
      - details
      - message
      - status
    ErrorResponseCore542688165:
      type: object
      additionalProperties: false
      description: More than 100 users cannot be associated
      properties:
        code:
          type: string
          description: Error code
          enum:
          - LIMIT_EXCEEDED
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            api_name:
              type: string
              description: 'Detail field: api_name'
              maxLength: 255
            limit:
              type: integer
              format: int32
              description: 'Detail field: limit'
            json_path:
              type: string
              description: 'Detail field: json_path'
              maxLength: 1000
          required:
          - api_name
          - json_path
          - limit
        message:
          type: string
          description: Error message
          enum:
          - More than 100 users cannot be associated
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    DataNested1:
      type: object
      additionalProperties: false
      description: Nested schema for data
      properties:
        code:
          type: string
          description: 'Field: code'
          maxLength: 255
        details:
          $ref: '#/components/schemas/DetailsNested'
        message:
          type: string
          description: 'Field: message'
          maxLength: 255
        status:
          type: string
          description: 'Field: status'
          maxLength: 255
    GETHasMoreNested:
      type: object
      additionalProperties: false
      description: Nested schema for $has_more
      properties:
        Members:
          type: boolean
          description: 'Field: Members'
      required:
      - Members
    MembersNested:
      type: object
      additionalProperties: false
      description: contains member details
      properties:
        name:
          type:
          - string
          - 'null'
          description: name of the member
          maxLength: 8
        Members:
          $ref: '#/components/schemas/MembersNested'
          description: contains member details
        id:
          type:
          - string
          - 'null'
          description: id of the member
          maxLength: 18
    MembersBase:
      type: object
      additionalProperties: true
      description: Base schema for Members
      properties:
        module:
          type:
          - string
          - 'null'
          description: member module
          maxLength: 100
        name:
          type:
          - string
          - 'null'
          description: name of the owner
          enum:
          - Madeshwaran G
          maxLength: 100
        id:
          type:
          - string
          - 'null'
          description: id of the owner
          enum:
          - '4671651000000635001'
          maxLength: 100
    ErrorResponseCore1604218709:
      type: object
      additionalProperties: false
      description: the module name given seems to be invalid
      properties:
        code:
          type: string
          description: Error code
          enum:
          - INVALID_MODULE
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            resource_path_index:
              type: integer
              format: int32
              description: 'Detail field: resource_path_index'
          required:
          - resource_path_index
        message:
          type: string
          description: Error message
          enum:
          - the module name given seems to be invalid
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    ErrorResponseCore1335501272:
      type: object
      additionalProperties: false
      description: To value must be Greater than From value
      properties:
        code:
          type: string
          description: Error code
          enum:
          - DEPENDENT_MISMATCH
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            dependee:
              type: object
              additionalProperties: false
              description: 'Detail field: dependee'
              properties:
                api_name:
                  type: string
                  description: 'Nested detail field: api_name'
                  maxLength: 255
                json_path:
                  type: string
                  description: 'Nested detail field: json_path'
                  maxLength: 1000
              required:
              - api_name
              - json_path
            api_name:
              type: string
              description: 'Detail field: api_name'
              maxLength: 255
            json_path:
              type: string
              description: 'Detail field: json_path'
              maxLength: 1000
          required:
          - api_name
          - dependee
          - json_path
        message:
          type: string
          description: Error message
          enum:
          - To value must be Greater than From value
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    GETOwnerNested:
      type: object
      additionalProperties: false
      description: Nested schema for Owner
      properties:
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        id:
          type: string
          description: 'Field: id'
          maxLength: 255
        email:
          type: string
          description: 'Field: email'
          maxLength: 255
      required:
      - email
      - id
      - name
    ErrorResponseCore1202290576:
      type: object
      additionalProperties: false
      description: record not deleted
      properties:
        code:
          type: string
          description: Error code
          enum:
          - INVALID_DATA
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            resource_path_index:
              type: integer
              format: int32
              description: 'Detail field: resource_path_index'
          required:
          - resource_path_index
        message:
          type: string
          description: Error message
          enum:
          - record not deleted
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    LayoutNested:
      type: object
      additionalProperties: false
      description: Layout id
      properties:
        id:
          type:
          - string
          - 'null'
          description: id
          maxLength: 18
    ErrorResponseCore1225158361:
      type: object
      additionalProperties: false
      description: Duration does not satisfy the service timing
      properties:
        code:
          type: string
          description: Error code
          enum:
          - DEPENDENT_MISMATCH
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            dependee:
              type: object
              additionalProperties: false
              description: 'Detail field: dependee'
              properties:
                api_name:
                  type: string
                  description: 'Nested detail field: api_name'
                  maxLength: 255
                json_path:
                  type: string
                  description: 'Nested detail field: json_path'
                  maxLength: 1000
              required:
              - api_name
              - json_path
            api_name:
              type: string
              description: 'Detail field: api_name'
              maxLength: 255
            json_path:
              type: string
              description: 'Detail field: json_path'
              maxLength: 1000
          required:
          - api_name
          - dependee
          - json_path
        message:
          type: string
          description: Error message
          enum:
          - Duration does not satisfy the service timing
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    ErrorResponseCore1835963120:
      type: object
      additionalProperties: false
      description: Unavailable Till must be greater than Unavailable From
      properties:
        code:
          type: string
          description: Error code
          enum:
          - DEPENDENT_MISMATCH
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            dependee:
              type: object
              additionalProperties: false
              description: 'Detail field: dependee'
              properties:
                api_name:
                  type: string
                  description: 'Nested detail field: api_name'
                  maxLength: 255
                json_path:
                  type: string
                  description: 'Nested detail field: json_path'
                  maxLength: 1000
              required:
              - api_name
              - json_path
            api_name:
              type: string
              description: 'Detail field: api_name'
              maxLength: 255
            json_path:
              type: string
              description: 'Detail field: json_path'
              maxLength: 1000
          required:
          - api_name
          - dependee
          - json_path
        message:
          type: string
          description: Error message
          enum:
          - Unavailable Till must be greater than Unavailable From
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    ErrorResponseCore1805991557:
      type: object
      additionalProperties: false
      description: Unavailable from must not be greater than current Time
      properties:
        code:
          type: string
          description: Error code
          enum:
          - INVALID_DATA
        details:
          type: object
          additionalProperties: false
          description: Error details with validation information
          properties:
            api_name:
              type: string
              description: 'Detail field: api_name'
              maxLength: 255
            json_path:
              type: string
              description: 'Detail field: json_path'
              maxLength: 1000
          required:
          - api_name
          - json_path
        message:
          type: string
          description: Error message
          enum:
          - Unavailable from must not be greater than current Time
        status:
          type: string
          description: Error status
          enum:
          - error
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    MembersitemBase:
      type: object
      additionalProperties: true
      description: Base schema for MembersItem
      properties:
        id:
          type:
          - string
          - 'null'
          description: id of the owner
          maxLength: 100
        Members:
          $ref: '#/components/schemas/MembersBase'
    GETMembersNested:
      type: object
      additionalProperties: false
      description: Nested schema for Members
      properties:
        module:
          type: string
          description: 'Field: module'
          maxLength: 255
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        id:
          type: string
          description: 'Field: id'
          maxLength: 255
      required:
      - id
      - module
      - name
    ModifiedByNested:
      type: object
      additionalProperties: false
      description: Nested schema for Modified_By
      properties:
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        id:
          type: string
          description: 'Field: id'
          maxLength: 255
    ErrorResponseCore1168955151:
      type: object
      additionalProperties: true
      description: Auto-generated from 207 Multi-Status error item
      properties:
        code:
          type: string
          description: Error code
          enum:
          - MANDATORY_NOT_FOUND
        details:
          type: object
          additionalProperties: true
          description: Error details with validation information
          properties:
            api_name:
              type: string
              description: 'Detail field: api_name'
              maxLength: 255
            json_path:
              type: string
              description: 'Detail field: json_path'
              maxLength: 1000
          required:
          - api_name
          - json_path
        message:
          type: string
          description: Error message
          maxLength: 100
        status:
          type: string
          description: Error status
          maxLength: 100
      required:
      - code
      - details
      - message
      - status
      title: Error Response Core
    CreatedByNested:
      type: object
      additionalProperties: false
      description: Nested schema for Created_By
      properties:
        name:
          type: string
          description: 'Field: name'
          maxLength: 255
        id:
          type: string
          description: 'Field: id'
          maxLength: 255
    GetservicessResponse200:
      type: object
      additionalProperties: true
      description: services records get , success response
      properties:
        data:
          type: array
          description: 'Field: data'
          items:
            $ref: '#/components/schemas/GETDataNested'
          maxItems: 1
      required:
      - data
    ErrorResponseCore591812267:
      type: object
      additionalProperties: false
      description: Auto-generated from ApiDefinition for INVALID_DATA
      properties:
        code:
          type: string
          description: Error code
          enum:
          - INVALID_DATA
        details:
          type: object
          additionalProperties: false
      

# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-services-s-api-openapi.yml