openapi: 3.0.0
info:
  title: Chats
  description: The Chats API enables effective management of conversations. It offers complete control over chat interactions, making it suitable for a range of messaging and collaboration scenarios. With these APIs, you can retrieve all chats, manage chat members, pin and unpin messages, mute and unmute conversations, and handle one-on-one, group chats and channels, etc.
  contact: {}
  version: 1.0.0
externalDocs:
  description: Find out more about Zoho Cliq APIs V2
  url: https://www.zoho.com/cliq/help/restapi/v2/
servers:
  - url: https://cliq.zoho.com/api/v2
    description: Zoho Cliq US DC
tags:
  - name: chats
    description: Chats Module
paths:
  /chats:
    get:
      summary: Retrieve all direct chats
      operationId: Retrieve all direct chats
      description: |
        Use this API to get details of all direct chats.
        <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            format: int64
            maxLength: 100
          description: 'The number of chats that has to be retrieved.Maximum limit : 100.'
        - name: modified_before
          in: query
          required: false
          schema:
            type: string
          description: Gets the list of chats where the last message is sent before the mentioned time.
        - name: modified_after
          in: query
          required: false
          schema:
            type: string
          description: Gets the list of chats where the last message is sent after the mentioned time.
        - name: drafts
          in: query
          required: false
          schema:
            type: boolean
          description: If drafts is set to true, it retrieves the list of chats that contain drafts.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  chats:
                    type: array
                    items:
                      $ref: '#/components/schemas/get-chats-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.READ
      tags:
        - chats
  /chats/{CHAT_ID}/members:
    get:
      summary: Retrieve the members of a chat
      operationId: Retrieve the members of a chat
      description: |
        Use this API to get details of members of a chat.
         <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: CHAT_ID
          in: path
          required: true
          schema:
            type: string
          description: The ID of the chat from which members need to be retrieved To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#CHAT_ID">CHAT_ID</a> in the Glossary page.
        - name: fields
          in: query
          required: false
          schema:
            type: string
          description: 'Use this parameter to get details of members who are participating in a conversation.Allowed values: name | email_id | user_id'
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/retrieve-chat-members'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.READ
      tags:
        - chats
  /chats/{CHAT_ID}/mute:
    post:
      summary: Mute a chat
      operationId: Mute a chat
      description: |
        Use this API to mute a chat conversation.
         <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: CHAT_ID
          in: path
          required: true
          schema:
            type: string
          description: The ID of the chat which needs to muted To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#CHAT_ID">CHAT_ID</a> in the Glossary page.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/no-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.UPDATE
      tags:
        - chats
  /chats/{CHAT_ID}/unmute:
    post:
      summary: Unmute a chat
      operationId: Unmute a chat
      description: |
        Use this API to unmute a chat conversation.
         <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: CHAT_ID
          in: path
          required: true
          schema:
            type: string
          description: The ID of the chat which needs to unmuted To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#CHAT_ID">CHAT_ID</a> in the Glossary page.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/no-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.UPDATE
      tags:
        - chats
  /chats/{CHAT_ID}/stickymessage:
    post:
      summary: Pin a message
      operationId: Pin a message
      description: |
        Use this API to pin a message within a conversation.
         <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: CHAT_ID
          in: path
          required: true
          schema:
            type: string
          description: The ID of the chat where the message should be pinned To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#CHAT_ID">CHAT_ID</a> in the Glossary page.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pin-a-message-request'
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pin-a-message-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.CREATE
      tags:
        - chats
    get:
      summary: Retrieve a pinned message
      operationId: Retrieve a pinned message
      description: |
        Use this API to retrieve a pinned message within a conversation.
         <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: CHAT_ID
          in: path
          required: true
          schema:
            type: string
          description: The ID of the chat where the pinned message needs to be retrieved To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#CHAT_ID">CHAT_ID</a> in the Glossary page.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-pinnedmessage-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.READ
      tags:
        - chats
    delete:
      summary: Unpin a message
      operationId: Unpin a message
      description: |
        Use this API to unpin a message in a conversation.
         <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: CHAT_ID
          in: path
          required: true
          schema:
            type: string
          description: The ID of the chat where the pinned message needs to be unpinned To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#CHAT_ID">CHAT_ID</a> in the Glossary page.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/no-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.DELETE
      tags:
        - chats
  /chats/{CHAT_ID}/leave:
    post:
      summary: Leave a group chat
      operationId: Leave a group chat
      description: |
        Use this API to exit a group chat.
         <br><br> 
        <p>
          <b>Threshold limit</b>: 20 requests per min per user<br>
          Number of API calls allowed within a minute.<br><br>
          <b>Lock period</b>: 10 minutes<br>Wait time before consecutive API requests.<br>
        </p>
      parameters:
        - name: CHAT_ID
          in: path
          required: true
          schema:
            type: string
          description: The ID of the group chat that you wish to exit To learn how to retrieve this ID, see <a href="/cliq/help/restapi/v2/glossary/#CHAT_ID">CHAT_ID</a> in the Glossary page.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/no-response'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The request cannot be performed. Usually because of malformed parameter or missing parameter.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Request was rejected because of invalid AuthToken.
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The user does not have enough permission or possibly not an user of the respective organization to access the resource.
        '404':
          description: Invalid URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The URL you've sent is wrong. It's possible that the resource you've requested has been moved to another URL.
        '405':
          description: Method Not Allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
        '406':
          description: Not Acceptable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: The response has been received but the requested response type is not supported by the browser.
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Too many requests within a certain time frame.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Cliq server encountered an error which prevents it from fulfilling the request.
      security:
        - Cliq_Auth:
            - ZohoCliq.Chats.UPDATE
      tags:
        - chats
components:
  schemas:
    no-response:
      type: object
      description: Response object returned when no content is available.
      properties:
        Response Code:
          type: string
          description: HTTP response code and message indicating no content.
          example: 204 No response
    get-chats-response:
      type: object
      description: Response object containing details of a chat or direct message.
      properties:
        name:
          type: string
          description: Display name of the chat or participant.
          example: Ryan West
        creation_time:
          type: string
          format: date-time
          description: Timestamp when the chat was created.
          example: '2019-10-15T03:37:28-07:00'
        creator_id:
          type: string
          description: Unique identifier of the user who created the chat.
          example: '631830848'
        last_modified_time:
          type: string
          format: date-time
          description: Timestamp when the chat was last modified.
          example: '2019-10-15T03:37:28-07:00'
        removed:
          type: boolean
          description: Indicates whether the chat has been removed.
          example: false
        recipients_summary:
          type: array
          description: List of participants in the chat with basic user details.
          items:
            $ref: '#/components/schemas/UserSummary'
        chat_type:
          type: string
          enum:
            - chat
            - dm
          description: Type of the chat, either a group chat (`chat`) or a direct message (`dm`).
          example: dm
        chat_id:
          type: string
          description: Unique identifier of the chat instance.
          example: '2230748224630350194'
        last_message_info:
          $ref: '#/components/schemas/LastMessageInfo'
        pinned:
          type: boolean
          description: Indicates if the chat is pinned by the user.
          example: false
        participant_count:
          type: integer
          description: Number of participants in the chat.
          example: 2
    UserSummary:
      type: object
      description: Basic details of a user in the chat.
      properties:
        user_id:
          type: string
          description: Unique identifier of the user.
          example: '631830848'
        name:
          type: string
          description: Full name of the user.
          example: Ryan West
    LastMessageInfo:
      type: object
      description: Information about the most recent message in the chat.
      properties:
        sender_id:
          type: string
          description: Unique identifier of the message sender.
          example: '631830849'
        message_type:
          type: string
          description: Type of the message (e.g., text, image, file).
          example: text
        styles:
          $ref: '#/components/schemas/MessageStyles'
        time:
          type: string
          format: date-time
          description: Timestamp when the message was sent.
          example: '2019-09-12T00:35:18-07:00'
        text:
          type: string
          description: Text content of the message.
          example: https://cliq.zoho.com/channels/marketing
        bot:
          $ref: '#/components/schemas/BotInfo'
        sender_name:
          type: string
          description: Display name of the message sender.
          example: Scott Fisher
    MessageStyles:
      type: object
      description: Style attributes applied to a message.
      properties:
        highlight:
          type: boolean
          description: Indicates if the message should be visually highlighted.
          example: true
    BotInfo:
      type: object
      description: Information about a bot associated with a message.
      properties:
        name:
          type: string
          description: Display name of the bot.
          example: Zia
        image_url:
          type: string
          format: uri
          description: URL of the bot's display image.
          example: https://img.zohostatic.com/chat/default/officechat/images/default/event-bot.png
    retrieve-chat-members:
      type: object
      description: Response object containing members of a chat.
      properties:
        members:
          type: array
          description: List of members in the chat with detailed user information.
          items:
            $ref: '#/components/schemas/Members'
    Members:
      type: object
      description: Detailed information about a chat member.
      properties:
        user_id:
          type: string
          description: Unique identifier of the user.
          example: '431930546'
        email_id:
          type: string
          format: email
          description: Email address of the user.
          example: olivia.palmer@zylcal.com
        name:
          type: string
          description: Full name of the user.
          example: Olivia - Content Writer
    pin-a-message-request:
      type: object
      description: Request body parameters for pinning a message in a chat.
      required:
        - id
      properties:
        id:
          type: string
          description: Unique identifier (msguid) of the message to be pinned.
          example: '1573708648341_375412769224'
        expiry_time:
          type: integer
          format: int64
          description: Expiry time in milliseconds for the pinned message.
          example: 1748946453794
        notify:
          type: boolean
          description: Indicates whether pinning the message should notify all participants.
          example: false
    pin-a-message-response:
      type: object
      description: Response object containing details of a pinned message.
      properties:
        data:
          type: object
          description: Details of the pinned message.
          properties:
            expiry_time:
              type: integer
              description: Expiry time set for the pinned message in milliseconds. `-1` indicates no expiry.
              example: -1
            creator:
              type: object
              description: Information about the user who pinned the message.
              properties:
                name:
                  type: string
                  description: Name of the message creator.
                  example: Scott Fisher
                id:
                  type: string
                  description: Unique identifier of the message creator.
                  example: '690440148'
            message:
              type: object
              description: Details of the pinned message.
              properties:
                msg:
                  type: string
                  description: Content of the pinned message.
                  example: meeting at 4
                sender:
                  type: string
                  description: Unique identifier of the original message sender.
                  example: '690440148'
                lmsgtime:
                  type: string
                  description: Timestamp when the message was last modified.
                  example: '1573708493055'
                msguid:
                  type: string
                  description: Unique identifier of the message.
                  example: 1573708648341%20375412769224
                time:
                  type: string
                  description: Timestamp when the message was sent.
                  example: '1573708648341'
                dname:
                  type: string
                  description: Display name of the original message sender.
                  example: Scott Fisher
            created_time:
              type: integer
              description: Timestamp when the message was pinned (in ms).
              example: 1573708712431
            last_modified_time:
              type: integer
              description: Timestamp when the pinned message was last modified (in ms).
              example: 1573708712431
            chat_id:
              type: string
              description: Unique identifier of the chat where the message was pinned.
              example: CT_2243173626687865223_P87610291-C4
    get-pinnedmessage-response:
      type: object
      description: Response object containing details of an existing pinned message.
      properties:
        type:
          type: string
          description: Type of the response object, usually `stickymessage`.
          example: stickymessage
        data:
          type: object
          description: Information about the pinned message.
          properties:
            expiry_time:
              type: integer
              description: Expiry time for the pinned message in milliseconds. `-1` indicates no expiry.
              example: -1
            creator:
              type: object
              description: Information about the user who pinned the message.
              properties:
                name:
                  type: string
                  description: Name of the creator.
                  example: Scott Fisher
                id:
                  type: string
                  description: Unique identifier of the creator.
                  example: '692133012'
            message:
              type: object
              description: Content details of the pinned message.
              properties:
                msg:
                  type: string
                  description: Text content of the message.
                  example: 'Feature review date: 15/11/2019'
                sender:
                  type: string
                  description: Unique identifier of the original message sender.
                  example: '690440148'
                lmsgtime:
                  type: string
                  description: Timestamp when the message was last modified.
                  example: '1573641920572'
                msguid:
                  type: string
                  description: Unique identifier of the message.
                  example: 1573641936588%20345281288778
                time:
                  type: string
                  description: Timestamp when the message was sent.
                  example: '1573641936588'
                dname:
                  type: string
                  description: Display name of the original message sender.
                  example: Ryan West
            created_time:
              type: integer
              description: Timestamp when the message was pinned (in ms).
              example: 1573641961788
            last_modified_time:
              type: integer
              description: Timestamp when the pinned message was last modified (in ms).
              example: 1573641961788
            chat_id:
              type: string
              description: Unique identifier of the chat where the message was pinned.
              example: CT_2243173626687865223_P87610291-C4
  securitySchemes:
    Cliq_Auth:
      type: oauth2
      x-authorization-example: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f
      flows:
        implicit:
          authorizationUrl: https://accounts.zoho.com/oauth/v2/auth
          scopes:
            ZohoCliq.Chats.CREATE: Create Chats
            ZohoCliq.Chats.READ: Read Chats
            ZohoCliq.Chats.UPDATE: Modify Chats
            ZohoCliq.Chats.DELETE: Delete Chats
