> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flextell.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Mark multiple conversations as read

> Marks every customer message of the conversations as read. A conversation that is already read succeeds
without a change.



## OpenAPI

````yaml post /v1/conversations/bulk/read
openapi: 3.1.0
info:
  title: Flextell API
  version: 0.0.1
  description: >-
    Flextell REST API referansı. Kimlik doğrulama, scope ve istek kuralları için
    API sekmesindeki rehberlere bakın.
servers:
  - url: https://app.flextell.ai/api
    description: Üretim
security:
  - oauth2: []
  - bearer: []
paths:
  /v1/conversations/bulk/read:
    post:
      tags:
        - Conversation
        - ConversationBulk
      summary: Mark multiple conversations as read
      description: >-
        Marks every customer message of the conversations as read. A
        conversation that is already read succeeds

        without a change.
      operationId: conversationBulk.markAsRead
      parameters:
        - name: X-Tenant
          in: header
          required: true
          description: >-
            Tenant identifier. Send the Tenant ID in the `X-Tenant` header to
            scope API requests to a specific tenant.
          schema:
            type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConversationBulkMarkAsReadRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    anyOf:
                      - type: object
                        properties:
                          success_count:
                            type: integer
                          failed_count:
                            type: integer
                          results:
                            type: array
                            items:
                              type: object
                              properties:
                                conversation_id:
                                  type: integer
                                success:
                                  type: boolean
                                error_code:
                                  type: string
                                message:
                                  type: string
                              required:
                                - conversation_id
                                - success
                        required:
                          - success_count
                          - failed_count
                          - results
                      - type: object
                        properties:
                          queued:
                            type: boolean
                          count:
                            type: integer
                        required:
                          - queued
                          - count
                required:
                  - success
                  - data
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '422':
          $ref: '#/components/responses/ValidationException'
        '428':
          description: >-
            Mandatory setup is incomplete. Finish the setup wizard first;
            `data.next_step` names the step to continue with.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    examples:
                      - false
                  error_code:
                    type: string
                    enum:
                      - SETUP_REQUIRED
                    examples:
                      - SETUP_REQUIRED
                  message:
                    type: string
                    examples:
                      - Complete the required setup steps to continue.
                  data:
                    type: object
                    properties:
                      next_step:
                        type:
                          - string
                          - 'null'
                        examples:
                          - clinic_info
                    required:
                      - next_step
                required:
                  - success
                  - error_code
                  - message
                  - data
components:
  schemas:
    ConversationBulkMarkAsReadRequest:
      type: object
      properties:
        ids:
          type: array
          description: >-
            The identifiers of the selected records. Send either these or
            `select_all`.
          items:
            type: integer
            minimum: 1
          minItems: 1
          maxItems: 100
        select_all:
          type: boolean
          description: >-
            Select every record the list shows with the filters in `filters`.
            The action then runs in the background and the response only carries
            the number of records.
        filters:
          type:
            - object
            - 'null'
          description: >-
            With `select_all`, the filters the list shows, as an object: the
            query parameters of `GET /api/v1/conversations` with the same names
            and values, array parameters without the `[]`. Paging and sorting
            parameters are ignored.
          properties:
            scope:
              type:
                - string
                - 'null'
              description: >-
                Which conversations to list: `assigned` for the ones whose lead
                is assigned to you, `all` (the default) for every conversation
                you may see. Without permission to view all conversations, `all`
                covers the conversations of the patients you may open: those
                whose lead is assigned to you and, for a salesperson, the team's
                converted and lead-less patients.
              enum:
                - assigned
                - all
                - null
            search:
              type:
                - string
                - 'null'
              description: >-
                The search query: every word is matched anywhere in the
                patient's first or last name (accent- and case-insensitive), and
                the digits of the query anywhere in the WhatsApp number or the
                patient's or lead's phone number, ignoring spaces, `+`, `-`,
                brackets and a leading 0 (`0532 123 45 67`, `532…` and `+90
                532…` all match). A number fragment needs at least three digits.
              maxLength: 255
            channel_type:
              type:
                - string
                - 'null'
              description: Filter by channel type (whatsapp, instagram, etc.).
              enum:
                - whatsapp
                - instagram
                - website
                - telegram
                - null
            channel_ids:
              type: array
              description: A channel ID to filter by.
              items:
                type: integer
            archived:
              type:
                - boolean
                - 'null'
              description: >-
                Filter by archive state. Pass true for archived conversations
                only, false for active ones. Defaults to active conversations
                when omitted.
            archive_states:
              type: array
              description: 'An archive state: "active" or "archived".'
              enum:
                - active
                - archived
              items:
                type: string
                enum:
                  - active
                  - archived
            lead_reference_source_ids:
              type: array
              description: A lead reference source ID to filter by.
              items:
                type: integer
            assigned_user_ids:
              type: array
              description: A user ID to filter by.
              items:
                type: integer
            tags:
              type: array
              description: A tag ID to filter by.
              items:
                type: integer
            archived_at_from:
              type:
                - string
                - 'null'
              format: date-time
              description: Only include conversations archived at or after this date.
            archived_at_to:
              type:
                - string
                - 'null'
              format: date-time
              description: Only include conversations archived at or before this date.
            lead:
              type:
                - string
                - 'null'
              description: >-
                Filter by customer stage. Pass "lead" for conversations whose
                customer is still a lead, or "patient" for converted customers.
                Omit for all.
              enum:
                - lead
                - patient
                - null
            read_state:
              type:
                - string
                - 'null'
              description: >-
                Filter by read state. Pass "unread" for conversations with a
                customer message that has not been read yet (the ones with a
                non-zero `unread_count`), or "read" for conversations without
                one. Omit for all. With `group_lines`, a contact on several
                WhatsApp lines counts as unread when any of its lines is.
              enum:
                - unread
                - read
                - null
            has_open_task:
              type:
                - boolean
                - 'null'
              description: >-
                Filter by open tasks of the customer, including the tasks added
                on its lead. Pass true for conversations with at least one open
                task, false for conversations without any.
            group_lines:
              type:
                - boolean
                - 'null'
              description: >-
                List a contact the clinic talks to on several WhatsApp lines
                once, as its most recently active line's conversation; `lines`
                on each row lists all of them. Ignored when `channel_ids`
                narrows the list to given lines.
        except_ids:
          type:
            - array
            - 'null'
          description: >-
            With `select_all`, the identifiers of the records to leave out, at
            most 1000.
          items:
            type: integer
            description: A record identifier to leave out.
            minimum: 1
          maxItems: 1000
        group_lines:
          type:
            - boolean
            - 'null'
          description: >-
            Whether the rows were selected in the list grouped by contact
            (`group_lines` of `GET /conversations`): a grouped row stands for
            all of the contact's WhatsApp lines, which change with it. With
            `select_all` it also groups the list the selection is made from.
      title: ConversationBulkMarkAsReadRequest
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.flextell.ai/oauth/authorize
          tokenUrl: https://app.flextell.ai/oauth/token
          scopes:
            '*': all
    bearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.