openapi: 3.0.0
info:
  title: Reminders
  description: |
    Cliq's reminders help you keep track of essential tasks that you need to complete but don't want to forget. <br><br> They make micromanaging your tasks effortless. With these APIs, you can create, edit, and mark reminders as complete or incomplete, snooze, retrieve, and assign users to specific reminders. <br><br> You can create and assign reminders to yourself, a teammate or colleague, a chat, or a channel. Additionally, you can set a specific message in a chat as a reminder. Each type of reminder requires its own set of parameters to be included in the request body.
  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: reminders
    description: Reminders Module
paths:
  /reminders:
    post:
      summary: Create a reminder
      operationId: Create a reminder
      description: |
        Create and assign reminders to yourself, your teammate, or your colleague. You can also assign reminders to a chat or a channel, or set a message in chat as a reminder. Each reminder type comes with its own set of necessary parameters to be passed in the request body. <br><br> <b>There are four types of reminders you can create:</b> <ol>
          <li>
            <b>Self Reminder</b> - Reminds yourself at a specified time.</b><br>
            <i>Usecase: Reminding yourself about a task or follow-up.</i>
          </li>
          <li>
            <b>User Reminder</b> - Assigns a reminder to one or more teammates.</b><br>
            <i>Usecase: Reminders assigned to colleagues or team members.</i>
          </li>
          <li>
            <b>Chat or Channel Reminder</b> - Assigns a reminder to a specific chat or channel.</b><br>
            <i>Usecase: Reminders associated with a group chat or a channel.</i>
          </li>
          <li>
            <b>Message Reminder</b> - Sets a specific chat message as a reminder.</b><br>
            <i>Usecase: Bookmarking an important message to revisit later.</i>
          </li>
        </ol> <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>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create-reminder-request-body'
            examples:
              self_reminder:
                summary: Self Reminder - Content review task
                value:
                  content: Content Review for ZylCal
                  time: '1506571200000'
              user_reminder:
                summary: User Reminder - Assign to teammates
                value:
                  content: ZylCal Marketplace Apps Review
                  time: '1506571200000'
                  user_ids:
                    - '2343536'
                    - '9876543'
              chat_reminder:
                summary: Chat/Channel Reminder - Assign to a chat
                value:
                  content: Appathon submissions review
                  time: '1506571200000'
                  chat_ids:
                    - '1277744356562927809'
              message_reminder:
                summary: Message Reminder - Set a chat message as reminder
                value:
                  message_id: '1536662288710'
                  chat_id: '1234572980899407452'
                  time: '1506571200000'
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/self-reminder-response'
                  - $ref: '#/components/schemas/user-reminder-response'
                  - $ref: '#/components/schemas/chat-reminder-response'
                  - $ref: '#/components/schemas/message-reminder-response'
              examples:
                self_reminder:
                  summary: Self Reminder response
                  value:
                    creation_time: 1506398400000
                    creator:
                      name: Scott Fisher
                      id: 1234567
                    completed: false
                    content: Content Review for ZylCal
                    time: 1506571200000
                    users:
                      - deleted: false
                        name: Scott Fisher
                        completed: false
                        id: '1234567'
                    id: '11360000000204007'
                user_reminder:
                  summary: User Reminder response
                  value:
                    creation_time: 1506398400000
                    creator:
                      name: Scott Fisher
                      id: 12345678
                    completed: false
                    content: ZylCal Marketplace Apps Review
                    time: 1506571200000
                    users:
                      - deleted: false
                        name: Ryan West
                        completed: false
                        id: '2343536'
                      - deleted: false
                        name: Olivia Palmer
                        completed: false
                        id: '9876543'
                    id: '11360000000204003'
                chat_reminder:
                  summary: Chat/Channel Reminder response
                  value:
                    creation_time: 1506398400000
                    creator:
                      name: Scott Fisher
                      id: 12345678
                    completed: false
                    content: Appathon submissions review
                    time: 1506571200000
                    chats:
                      - completed: false
                        chat_id: '1277744356562927809'
                        title: Zylker Appathon
                    id: '11360000000204011'
                message_reminder:
                  summary: Message Reminder response
                  value:
                    users:
                      - deleted: false
                        name: Ryan West
                        completed: false
                        id: '2343536'
                    id: '11360000000204021'
                    time: 1506571200000
                    creator:
                      name: Scott Fisher
                      id: 12345678
                    creation_time: 1506398400000
                    completed: false
                    content: Annual Sales Report Q3 due tomorrow
                    message:
                      sender_id: '12345678'
                      message_id: 1536662288710
                      chat_id: '1234572980899407452'
        '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.Reminders.CREATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
    get:
      summary: Get list of all reminders
      operationId: Get the list of all reminders
      description: |
        Use this API to retrieve details for all reminders. If no specific category is indicated, the API will return a list of reminders under the default category "mine." By default, the API provides a list of 20 reminders.<br><br>
        <b>next_set_token:</b> This token will be issued in two scenarios:
        <ul>
          <li>If no limit is specified and there are more than 20 reminders in your list.</li>
          <li>If you set a limit on the number of reminders to be retrieved, the token will be provided to access the next set of reminders. Please note that the token will be given only if the total number of reminders exceeds the limit you specified.</li>
        </ul>
        <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: category
          in: query
          schema:
            type: string
          description: |
            Retrieves reminders from the specified category.<br>
            Allowed values:
            <ul>
              <li><b>mine</b>: Active reminders assigned to or created by the user (default).</li>
              <li><b>mine-completed</b>: Completed reminders assigned to or created by the user.</li>
              <li><b>others</b>: Active reminders created by the user for others (users or chats).</li>
              <li><b>others-completed</b>: Completed reminders created by the user for others.</li>
            </ul>
          example: mine
        - name: limit
          in: query
          schema:
            type: number
          description: Specify the number of reminders to be retrieved.
          example: 30
        - name: next_set_token
          in: query
          schema:
            type: string
          description: Specify this token to fetch the next set of reminders.
          example: eyJvZmZzZXQiOjIwLCJsaW1pdCI6MjB9
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-reminders-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.Reminders.READ
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}:
    get:
      summary: Retrieve a reminder
      operationId: Retrieve a reminder
      description: |
        Use this API to obtain details of a specific reminder by providing the reminder ID in the query. You can retrieve the reminder ID from the API's response that lists all reminders.
         <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder for which detailed information needs to be retrieved.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/retrieve-reminder'
        '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.Reminders.READ
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
    put:
      summary: Update a reminder
      operationId: Update a reminder
      description: |
        Use this API to edit the details of a specific reminder by providing the reminder ID. You can obtain the reminder ID from the API's response that lists all reminders.
         <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder which needs to be updated.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-reminder-request-body'
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/update-reminder-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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
    delete:
      summary: Delete a reminder
      operationId: Delete a reminder
      description: |
        Use this API to delete a particular reminder by giving the reminder ID. You can obtain the reminder ID from the API's response that lists all reminders.
         <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder which needs to be deleted.
      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.Reminders.DELETE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/batch:
    delete:
      summary: Delete Reminders
      operationId: Delete Reminders
      description: |
        Use this API to delete a list of reminders by providing the reminder IDs. You can obtain the reminder ID from the API's response that lists all reminders.
          <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>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/delete-reminders-request-body'
      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.Reminders.DELETE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/clearcompleted:
    delete:
      summary: Delete completed reminders
      operationId: Delete completed reminders
      description: |
        Use this API to delete the list of reminders that are marked as complete.
        <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>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/delete-completed-reminders-request-body'
      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.Reminders.DELETE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/complete:
    put:
      summary: Mark a reminder as complete
      operationId: Mark a reminder as complete
      description: |
        Use this API to mark a reminder as complete by providing the reminder ID.<br>
        <b>Note</b>: Reminders set for yourself (i.e falling under the mine category) can be marked as complete or incomplete.
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder which needs to be marked as completed.
      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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/incomplete:
    put:
      summary: Mark a reminder as incomplete
      operationId: Mark a reminder as incomplete
      description: |
        Use this API to mark a reminder as incomplete by providing the reminder ID.
        <b>Note</b>: Reminders set for yourself (i.e falling under the mine category) can be marked as complete or incomplete.
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder which needs to be marked as incomplete.
      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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/snooze:
    put:
      summary: Snooze a reminder
      operationId: Snooze a reminder
      description: |
        Use this API to snooze a reminder by providing the reminder ID.
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder which needs to be snoozed.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/snooze-reminder-request-body'
      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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/dismisssnooze:
    put:
      summary: Dismiss a snoozed reminder
      operationId: Dismiss a snoozed reminder
      description: |
        Use this API to dismiss a snoozed reminder by providing the reminder ID.
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the snoozed reminder which needs to be dismissed.
      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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/users:
    post:
      summary: Assign users to a reminder
      operationId: Assign users to a reminder
      description: |
        Use this API to assign users to reminders. A maximum of 4 users can be assigned to a reminder.
        <b>Note</b>: This API will work with reminders added in the Others category
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder for which users needs to be assigned.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/assign-users-to-reminder-request-body'
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/assign-user-reminder-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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/users/{USER_ID}:
    delete:
      summary: Unassign a user from a reminder
      operationId: Unassign a user from a reminder
      description: |
        Use this API to unassign users from a reminder, by providing their User ID.
        <b>Note</b>: This API will work with reminders added in the Others category, i.e. reminders assigned by you to others.
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder for which users needs to be unassigned.
        - name: USER_ID
          in: path
          required: true
          schema:
            type: string
          example: USER_ID
          description: The ID of the user who needs to be unassigned from the reminder.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/unassign-user-reminder-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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/users/{USER_ID}/remind:
    put:
      summary: Remind assignee
      operationId: Remind assignee
      description: |
        Use this API to trigger a notification in Taz to a particular assignee who is yet to mark the reminder as complete.
        <b>Note</b>: This API will work with reminders added in the Others category, i.e. reminders assigned by you to others.
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder for which needs to be notified via Taz bot.
        - name: USER_ID
          in: path
          required: true
          schema:
            type: string
          example: USER_ID
          description: The ID of the user who needs to be reminded via Taz bot to mark the reminder as complete.
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/remind-assignee-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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
  /reminders/{REMINDER_ID}/remind:
    post:
      summary: Remind assignees
      operationId: Remind assignees
      description: |
        Use this API to trigger a notification in Taz to a reminder's assignees who are yet to mark the reminder as complete.
        <b>Note</b>: This API will work with reminders added in the Others category
        <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: REMINDER_ID
          in: path
          required: true
          schema:
            type: string
          example: REMINDER_ID
          description: The ID of the reminder for which users needs to be notified via Taz bot.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/assign-users-to-reminder-request-body'
      responses:
        '200':
          description: The request was successfully completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/remind-assignee-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.Reminders.UPDATE
            - ZohoCliq.Reminders.ALL
      tags:
        - reminders
components:
  schemas:
    no-response:
      type: object
      description: Generic response object when no content is returned.
      properties:
        Response Code:
          type: string
          description: HTTP response code indicating the result of the operation.
          example: 204 No response
    remind-assignee-response:
      type: object
      description: Response object for reminding an assignee.
      properties:
        id:
          type: string
          description: Unique identifier of the reminder or assignee.
          example: '2343536'
        name:
          type: string
          description: Name of the assignee.
          example: Ryan West
        completed:
          type: boolean
          description: Indicates if the reminder is marked as completed.
          example: false
        deleted:
          type: boolean
          description: Indicates if the reminder or user assignment has been deleted.
          example: false
    delete-reminders-request-body:
      type: object
      description: Request body to delete one or more reminders.
      required:
        - reminder_ids
      properties:
        reminder_ids:
          type: array
          description: Unique IDs of the reminders to be deleted. Maximum 20 IDs.
          items:
            type: string
            description: A single reminder ID to delete.
          example:
            - '11360000000205005'
            - '11360000000205009'
    delete-completed-reminders-request-body:
      type: object
      description: Request body to delete completed reminders based on category.
      required:
        - category
      properties:
        category:
          type: string
          description: |
            Indicates the category of completed reminders to clear.
            Allowed values:
            <ul>
              <li><b>mine-completed</b>: Completed reminders created by or assigned to the user.</li>
              <li><b>others-completed</b>: Completed reminders for other users or chats.</li>
            </ul>
          example: mine-completed
    create-reminder-request-body:
      type: object
      description: |
        Request body for creating a reminder. The fields required depend on the type of reminder being created. Pass only the fields applicable to your reminder type - do not mix fields across types.<br><br> <b>Reminder types and their required fields:</b> <ul>
          <li><b>Self Reminder</b>: <code>content</code> (required), <code>time</code> (optional)</li>
          <li><b>User Reminder</b>: <code>content</code> (required), <code>time</code> (required), <code>user_ids</code> (required)</li>
          <li><b>Chat / Channel Reminder</b>: <code>content</code> (required), <code>time</code> (required), <code>chat_ids</code> (required)</li>
          <li><b>Message Reminder</b>: <code>time</code> (required), <code>message_id</code> (required), <code>chat_id</code> (required)</li>
        </ul>
      properties:
        content:
          type: string
          description: |
            <ul>
              <li>The text content or subject of the reminder. This is what will be displayed when the reminder triggers.</li>
              <li><b>Maximum length:</b> 512 characters.</li>
              <li>Applicable for: <i>Self Reminder, User Reminder, Chat/Channel Reminder.</i></li>
              <li><b>Not applicable for Message Reminder</b> (content is auto-derived from the referenced message).</li>
            </ul>
          example: Content Review for ZylCal Conference
        time:
          type: number
          description: |
            <ul>
              <li>Timestamp for when the reminder should trigger, in milliseconds since the Unix epoch.</li>
              <li>For Self Reminder, this field is optional - omit it to create a reminder without a scheduled time.<br></li>
              <li><i>Applicable for: Self Reminder, User Reminder, Chat/Channel Reminder, Message Reminder.</i></li>
              <li><b>Not applicable for</b> reminders without a scheduled time.</li>
            </ul>
          example: 1506571200000
        user_ids:
          type: array
          description: |
            <ul>
              <li>An array of unique user IDs of the teammates or colleagues to whom this reminder is assigned.</li>
              <li><b>Maximum:</b> 4 assignees per reminder.</li>
              <li><i>Applicable for: User Reminder only.</i></li>
              <li><b>Not applicable for</b> Self Reminder, Chat/Channel Reminder, or Message Reminder.</li>
            </ul>
          maxItems: 4
          items:
            type: string
            description: Unique ID of a user to be assigned the reminder.
          example:
            - '2343536'
            - '9876543'
        chat_ids:
          type: array
          description: |
            <ul>
              <li>An array containing the unique ID of the chat or channel to which this reminder is assigned.</li>
              <li><b>Maximum:</b> 1 chat ID per request.</li>
              <li><i>Applicable for: Chat/Channel Reminder only.</i></li>
              <li><b>Not applicable for</b> Self Reminder, User Reminder, or Message Reminder.</li>
            </ul>
          maxItems: 1
          items:
            type: string
            description: Unique ID of the chat or channel.
          example:
            - '1277744356562927809'
        message_id:
          type: array
          description: |
            <ul>
              <li>An array containing the unique ID of the message to be set as a reminder. The content of this message will be used as the reminder text.</li>
              <li><b>Maximum:</b> 1 message ID per request.</li>
              <li><i>Applicable for: Message Reminder only.</i></li>
              <li><b>Not applicable for</b> Self Reminder, User Reminder, or Chat/Channel Reminder.</li>
            </ul>
          maxItems: 1
          items:
            type: string
            description: Unique ID of the message.
          example:
            - '1536662288710'
        chat_id:
          type: array
          description: |
            <ul>
              <li>An array containing the unique ID of the chat in which the referenced message exists. Used together with <code>message_id</code> to identify the source message.</li>
              <li><b>Maximum:</b> 1 chat ID per request.</li>
              <li><i>Applicable for: Message Reminder only.</i></li>
              <li><b>Not applicable for</b> Self Reminder, User Reminder, or Chat/Channel Reminder.</li>
            </ul>
          maxItems: 1
          items:
            type: string
            description: Unique ID of the chat containing the message.
          example:
            - '1234572980899407452'
    snooze-reminder-request-body:
      type: object
      description: Request to snooze an existing reminder.
      required:
        - time
      properties:
        time:
          type: integer
          description: Time in milliseconds to delay the reminder. Applied to current time.
          example: 900000
    assign-users-to-reminder-request-body:
      type: object
      description: Request to assign multiple users to a reminder.
      required:
        - user_ids
      properties:
        user_ids:
          type: array
          description: List of user IDs to assign to the reminder.
          items:
            type: string
            description: User ID of an assignee.
          example:
            - '7234192'
            - '2498713'
    update-reminder-request-body:
      type: object
      description: Request to update an existing reminder.
      required:
        - content
      properties:
        content:
          type: string
          description: Updated content of the reminder. Maximum 512 characters.
          example: Content Review for ZylCal Conference
        time:
          type: number
          description: Updated timestamp for the reminder trigger, in milliseconds.
          example: 1506571200000
    assign-user-reminder-response:
      type: object
      description: Response after assigning users to a reminder.
      properties:
        creation_time:
          type: integer
          description: Timestamp when the reminder was created.
          example: 1506398400000
        creator:
          type: object
          description: Details of the user who created the reminder.
          properties:
            name:
              type: string
              description: Name of the creator.
              example: Ryan West
            id:
              type: integer
              description: ID of the creator.
              example: 2343536
        completed:
          type: boolean
          description: Indicates if the reminder has been completed.
          example: false
        content:
          type: string
          description: Content or subject of the reminder.
          example: Functionality Design Review Meeting
        users:
          type: array
          description: List of users assigned to the reminder.
          items:
            type: object
            description: Details of an assigned user.
            properties:
              deleted:
                type: boolean
                description: Indicates if the user assignment has been deleted.
                example: false
              name:
                type: string
                description: Name of the assigned user.
                example: Scott Fisher
              completed:
                type: boolean
                description: Indicates if the assigned user completed the reminder.
                example: false
              id:
                type: string
                description: User ID of the assignee.
                example: '1234567'
        id:
          type: string
          description: Unique identifier of the reminder.
          example: '11360000000205013'
    unassign-user-reminder-response:
      type: object
      description: Response after unassigning a user from a reminder.
      properties:
        creation_time:
          type: integer
          description: Timestamp when the reminder was created.
          example: 1506398400000
        creator:
          type: object
          description: Details of the reminder creator.
          properties:
            name:
              type: string
              description: Creator's name.
              example: Ryan West
            id:
              type: integer
              description: Creator's ID.
              example: 2343536
        completed:
          type: boolean
          description: Indicates if the reminder has been completed.
          example: false
        content:
          type: string
          description: Content of the reminder.
          example: Functionality Design Review Meeting
        users:
          type: array
          description: Remaining users assigned to the reminder.
          items:
            type: object
            properties:
              deleted:
                type: boolean
                description: Indicates if the user assignment has been deleted.
                example: false
              name:
                type: string
                description: Name of the assigned user.
                example: Scott Fisher
              completed:
                type: boolean
                description: Indicates if the assigned user completed the reminder.
                example: false
              id:
                type: string
                description: User ID of the assignee.
                example: '1234567'
        id:
          type: string
          description: Unique identifier of the reminder.
          example: '11360000000205013'
    update-reminder-response:
      type: object
      description: Response after updating a reminder.
      properties:
        creation_time:
          type: integer
          description: Timestamp of reminder creation.
          example: 1506398400000
        creator:
          type: object
          description: Reminder creator details.
          properties:
            name:
              type: string
              description: Name of the creator.
              example: Scott Fisher
            id:
              type: integer
              description: Creator ID.
              example: 1234567
        completed:
          type: boolean
          description: Indicates if the reminder is completed.
          example: false
        content:
          type: string
          description: Updated content of the reminder.
          example: Appathon submissions code and content review
        time:
          type: integer
          description: Updated timestamp of the reminder in milliseconds.
          example: 1506571200000
        chats:
          type: array
          description: List of chats associated with the reminder.
          items:
            type: object
            properties:
              completed:
                type: boolean
                description: Indicates if the reminder in the chat is completed.
                example: false
              chat_id:
                type: string
                description: Chat ID associated with the reminder.
                example: '1277744356562927809'
              title:
                type: string
                description: Chat title.
                example: Zylker Appathon
        id:
          type: string
          description: Unique identifier of the reminder.
          example: '11360000000207025'
    self-reminder-response:
      type: object
      description: Response object for a self reminder.
      properties:
        creation_time:
          type: integer
          description: Timestamp of creation.
          example: 1506398400000
        creator:
          type: object
          description: Creator of the self reminder.
          properties:
            name:
              type: string
              description: Name of the creator.
              example: Scott Fisher
            id:
              type: integer
              description: Creator ID.
              example: 1234567
        completed:
          type: boolean
          description: Indicates if the self reminder is completed.
          example: false
        content:
          type: string
          description: Content of the reminder.
          example: Content Review for ZylCal
        time:
          type: integer
          description: Time in milliseconds when the reminder will trigger.
          example: 1506571200000
        users:
          type: array
          description: Users associated with the reminder.
          items:
            type: object
            properties:
              deleted:
                type: boolean
                description: Indicates if the user assignment has been deleted.
                example: false
              name:
                type: string
                description: User name.
                example: Scott Fisher
              completed:
                type: boolean
                description: Indicates if the user completed the reminder.
                example: false
              id:
                type: string
                description: User ID.
                example: '1234567'
        id:
          type: string
          description: Unique identifier of the reminder.
          example: '11360000000204007'
    retrieve-reminder:
      type: object
      description: Response object representing a retrieved reminder.
      properties:
        creation_time:
          type: integer
          description: Timestamp when the reminder was created.
          example: 1506398400000
        creator:
          type: object
          description: Information about the user who created the reminder.
          properties:
            name:
              type: string
              description: Name of the creator.
              example: Scott Fisher
            id:
              type: integer
              description: ID of the creator.
              example: 1234567
        completed:
          type: boolean
          description: Indicates whether the reminder is completed.
          example: false
        content:
          type: string
          description: Content or subject of the reminder.
          example: Appathon submissions review
        time:
          type: integer
          description: Timestamp in milliseconds when the reminder is set to trigger.
          example: 1506571200000
        chats:
          type: array
          description: List of chats associated with this reminder.
          items:
            type: object
            properties:
              completed:
                type: boolean
                description: Indicates if the reminder in this chat has been completed.
                example: false
              chat_id:
                type: string
                description: Unique identifier of the chat.
                example: '1277744356562927809'
              title:
                type: string
                description: Title of the chat.
                example: Zylker Appathon
        id:
          type: string
          description: Unique identifier of the reminder.
          example: '11360000000204011'
    get-reminders-response:
      type: object
      description: Response object returning a list of reminders filtered by category.
      properties:
        category:
          type: string
          description: Category of reminders returned (e.g., 'mine', 'others').
          example: mine
        list:
          type: array
          description: List of reminder objects.
          items:
            type: object
            properties:
              creation_time:
                type: integer
                description: Timestamp when the reminder was created.
                example: 1506398400000
              creator:
                type: object
                description: Information about the user who created the reminder.
                properties:
                  name:
                    type: string
                    description: Creator's name.
                    example: Ryan West
                  id:
                    oneOf:
                      - type: string
                        description: Creator ID as a string.
                        example: '2343536'
                      - type: integer
                        description: Creator ID as an integer.
                        example: 1234567
              completed:
                type: boolean
                description: Indicates whether the reminder is marked as completed.
                example: false
              content:
                type: string
                description: Content or description of the reminder.
                example: Annual sales review report due tomorrow
              time:
                type: integer
                description: Optional timestamp when the reminder is set to notify.
                example: 1506571200000
              users:
                type: array
                description: List of users associated with the reminder.
                items:
                  type: object
                  properties:
                    deleted:
                      type: boolean
                      description: Indicates if the user assignment has been deleted.
                      example: false
                    name:
                      type: string
                      description: Name of the assigned user.
                      example: Scott Fisher
                    completed:
                      type: boolean
                      description: Indicates whether the user has completed the reminder.
                      example: false
                    id:
                      type: string
                      description: User ID of the assignee.
                      example: '1234567'
              id:
                type: string
                description: Unique identifier of the reminder.
                example: '11360000000204033'
              message:
                type: object
                description: Optional message context if the reminder is associated with a message.
                properties:
                  sender_id:
                    type: string
                    description: User ID of the message sender.
                    example: '2343536'
                  message_id:
                    type: integer
                    description: Unique identifier of the message.
                    example: 1536853438313
                  chat_id:
                    type: string
                    description: ID of the chat where the message exists.
                    example: CT_1277744254305568677_53600857
    user-reminder-response:
      type: object
      description: Response object after creating a reminder for specific users.
      required:
        - reminder_id
        - time
        - user_ids
      properties:
        reminder_id:
          type: string
          description: Unique identifier of the created reminder.
        content:
          type: string
          description: Content of the reminder.
        time:
          type: integer
          format: int64
          description: Time when the reminder will trigger, in milliseconds.
        user_ids:
          type: array
          description: List of user IDs assigned to the reminder.
          maxItems: 4
          items:
            type: string
      example:
        content: ZylCal Marketplace Apps Review
        time: 1506571200000
        user_ids:
          - '2343536'
          - '9876543'
    chat-reminder-response:
      type: object
      description: Response object after creating a reminder for a chat.
      required:
        - content
        - time
        - chat_ids
      properties:
        content:
          type: string
          description: Content of the reminder.
        time:
          type: integer
          format: int64
          description: Time when the reminder will trigger, in milliseconds.
        chat_ids:
          type: array
          description: List of chat IDs assigned to the reminder.
          maxItems: 1
          items:
            type: string
            description: Chat ID linked to the reminder.
    message-reminder-response:
      type: object
      description: Response object after creating a reminder for a message.
      required:
        - time
        - message_id
        - chat_id
      properties:
        time:
          type: integer
          format: int64
          description: Time when the reminder will trigger, in milliseconds.
        message_id:
          type: array
          description: Message ID(s) linked to the reminder.
          maxItems: 1
          items:
            type: string
            description: Unique message ID.
        chat_id:
          type: array
          description: Chat ID(s) linked to the reminder.
          maxItems: 1
          items:
            type: string
            description: Unique chat ID.
      example:
        time: 1506571200000
        message_id:
          - '1536662288710'
        chat_id:
          - '1234572980899407452'
  securitySchemes:
    Cliq_Auth:
      type: oauth2
      x-authorization-example: Bearer 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f
      flows:
        implicit:
          authorizationUrl: https://accounts.zoho.com/oauth/v2/auth
          scopes:
            ZohoCliq.Reminders.CREATE: Create Reminders
            ZohoCliq.Reminders.READ: Read Reminders
            ZohoCliq.Reminders.UPDATE: Update Reminders
            ZohoCliq.Reminders.DELETE: Delete Reminders
            ZohoCliq.Reminders.ALL: Create , Read , Update and Manage reminders
