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

# Mark a thread read or unread



## OpenAPI

````yaml /openapi.json post /inbox/threads/{thread_id}/read/
openapi: 3.1.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: >-
    REST API reference for Oneprofile, the GTM data layer for your CRM. Manage
    tables, enrichments, and integrations. Authenticate with an API key to get
    started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: API Reference | Oneprofile
  version: '0.0'
servers:
  - url: https://api.getoneprofile.ai
security: []
tags:
  - description: Sender profiles, connected mailboxes, tags, and the Google connect flow.
    name: senders
  - description: The workspace do-not-contact list, enforced before every send.
    name: suppression
  - description: 'Sequence authoring: the graph, the table-backed audience, previews.'
    name: sequences
  - description: >-
      The LinkedIn channel: connecting an account to a sender, its safety limits
      and history, and the protocol the browser extension speaks.
    name: linkedin
  - description: 'The unified outreach inbox: threads, replies, labels, events.'
    name: inbox
  - description: 'The AI reply layer: workspace settings, drafts, and approval.'
    name: inbox-ai
  - description: Notification rules, per-user preferences, and the Slack connection.
    name: notifications
  - description: Endpoints for seeing all available integration types.
    name: integration-types
  - description: Endpoints for creating and managing integrations.
    name: integrations
  - description: Endpoints for the generic OAuth install/claim app-listings engine.
    name: app-listings
  - description: Endpoints for creating and managing API keys.
    name: apikey
  - description: Endpoints for managing billing and subscription information.
    name: billing
  - description: Endpoints for creating and managing tables.
    name: tables
  - description: Endpoints for table columns, formula previews, and on-demand column runs.
    name: table-columns
  - description: Endpoints for table rows and manual cell edits.
    name: table-rows
  - description: Endpoints for observing and cancelling table recompute runs.
    name: table-runs
  - description: >-
      Endpoints for org-shared per-column display preferences: hidden, pinned,
      width, and colour tint.
    name: table-ui-prefs
  - description: >-
      Endpoints for the org-shared names given to the column tint palette: what
      this organisation calls each colour. Org-level, not per-table.
    name: table-column-color-labels
  - description: >-
      Endpoints for the enrichment action catalog, model list, presets, draft
      generation, and saved agents.
    name: table-enrichments
  - description: >-
      Endpoints for teaching a saved agent from example rows: training sessions,
      per-row feedback, and the proposed prompt to approve.
    name: agent-training
  - description: >-
      The durable audit trail of a table's enrichment actions: configured,
      edited, run, cancelled, and settled cost.
    name: table-enrichment-audit-logs
  - description: Endpoints for saving and applying column templates.
    name: table-templates
  - description: Server-sent change feed for a table's grid.
    name: table-events
  - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.'
    name: table-views
  - description: >-
      The per-table AI Assistant: named conversations, the column suggestions a
      build turn produces, and the questions an analyze turn answers.
    name: table-assistant
  - description: >-
      Endpoints for PER-USER table preferences: favourites and recently opened.
      Unlike the rest of the table surface these are personal, so two members of
      one organisation legitimately see different answers.
    name: table-user-prefs
  - description: >-
      Endpoints for building a table from an uploaded CSV: upload and preview
      the inferred columns, commit the reviewed mapping, then poll the row load.
    name: table-imports
  - description: Endpoint for downloading a table's rows as CSV.
    name: table-export
  - description: >-
      Endpoints for the integration a table imports from: attach and preview it,
      promote imported fields into columns, and run the import on demand.
    name: table-sources
  - description: >-
      Endpoints for a table's recurring import cadence: set it, pause it, and
      read the next fire times.
    name: table-schedules
  - description: >-
      Endpoints for pushing a table's rows out to a connected integration: list
      writable destinations, derive their write capabilities, and map export
      columns.
    name: table-writeback
  - description: >-
      Endpoints backing a lookup column's setup: the connections whose records a
      column could read, and the identity fields one record type can be looked
      up by.
    name: table-integration-lookup
  - description: >-
      Endpoints for sourcing leads from the lead database: count and preview
      matches, land them in a table, and keep saved searches.
    name: find-leads
  - description: >-
      Endpoints for discovering a domain's subdomains from public certificate
      logs and landing the results in a table.
    name: find-subdomains
  - description: Endpoints for the credit balance meter and usage reporting.
    name: credits
  - description: >-
      Endpoints for the workspace referral program: the shareable link, the
      friends who joined through it, and claiming a code after signup.
    name: referral
  - description: >-
      Endpoints for the design partner program's customer surface: whether this
      workspace is a design partner, the badges its feedback has earned, and
      sending and reading that feedback.
    name: design-partner
  - description: >-
      Endpoints for the org-level AI business context — company description,
      ideal customer profile, buyer personas and interest signals — plus
      domain-based generation.
    name: ai-context
paths:
  /inbox/threads/{thread_id}/read/:
    post:
      tags:
        - inbox
      summary: Mark a thread read or unread
      operationId: set_thread_read
      parameters:
        - in: path
          name: thread_id
          required: true
          schema:
            format: uuid
            title: Thread Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ThreadReadFlagUpdateSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThreadReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Not found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
        - HTTPBearer: []
        - APIKeyHeader: []
components:
  schemas:
    ThreadReadFlagUpdateSchema:
      properties:
        read:
          title: Read
          type: boolean
      required:
        - read
      title: ThreadReadFlagUpdateSchema
      type: object
    ThreadReadSchema:
      properties:
        can_reply_on_linkedin:
          default: false
          description: >-
            INB-09: whether an explicit channel='linkedin' reply can go out on
            this thread — it carries a LinkedIn member identity and a paired
            account. The composer's channel toggle keys off this.
          title: Can Reply On Linkedin
          type: boolean
        channel:
          $ref: '#/components/schemas/InboxChannel'
        contact_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact Email
        contact_key:
          title: Contact Key
          type: string
        contact_linkedin_url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            INB-08: the contact's LinkedIn profile URL, when our own evidence
            (invitation ledger, dispatched actions, or the sequence's mapped
            column) names one. Only the SINGLE-thread read resolves it; the list
            leaves it null.
          title: Contact Linkedin Url
        contact_name:
          title: Contact Name
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        enrolment_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            §79: the contact's enrolment in this thread's sequence, when it has
            one — the id the 'Resume cadence' action targets.
          title: Enrolment Id
        has_pending_draft:
          default: false
          description: >-
            INB-04: an AI reply is waiting for approval on this thread — the
            list row's 'Action required' mark. Only the thread LIST populates
            it; single-thread reads leave it False and the open conversation
            fetches the draft itself.
          title: Has Pending Draft
          type: boolean
        id:
          format: uuid
          title: Id
          type: string
        is_bounce:
          title: Is Bounce
          type: boolean
        is_out_of_office:
          title: Is Out Of Office
          type: boolean
        is_unread:
          title: Is Unread
          type: boolean
        label_ids:
          items:
            format: uuid
            type: string
          title: Label Ids
          type: array
        last_message_at:
          format: date-time
          title: Last Message At
          type: string
        last_snippet:
          title: Last Snippet
          type: string
        mailbox_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Mailbox Id
        match_excerpt:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            §63: the matched message, headlined around the match. Only set when
            searching.
          title: Match Excerpt
        message_count:
          title: Message Count
          type: integer
        sequence_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Sequence Id
        snoozed_until:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: 'INB-12: hidden from the working views until this instant.'
          title: Snoozed Until
        step_id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Step Id
        stop_reason:
          anyOf:
            - $ref: '#/components/schemas/StopReason'
            - type: 'null'
          description: >-
            §79: set when the cadence is stopped (reply, unsubscribe, bounce,
            ...). None for a live or normally-completed enrolment. Only 'reply'
            is resumable.
        subject:
          title: Subject
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - contact_email
        - contact_key
        - channel
        - contact_name
        - mailbox_id
        - sequence_id
        - step_id
        - subject
        - last_message_at
        - last_snippet
        - is_unread
        - is_out_of_office
        - is_bounce
        - message_count
        - label_ids
        - created_at
        - updated_at
      title: ThreadReadSchema
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
        - detail
      title: UnauthorizedResponse
      type: object
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
        - detail
      title: ForbiddenResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
        - detail
      title: NotFoundResponse
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: >-
            The detail of the error. This is the error message to show to the
            user. You should also use the issues field to show more detailed
            error messages per field. Use this field for a single liner error
            message.
          title: Detail
          type: string
        issues:
          description: >-
            The issues that caused the error. There can be multiple issues. Each
            issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
        - detail
        - issues
      title: UnprocessableEntityResponse
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
        - detail
      title: ServerErrorResponse
      type: object
    InboxChannel:
      description: >-
        Which surface a conversation happens on.


        Threads are contact-scoped, not channel-scoped, so this says how a
        thread is

        REACHED rather than partitioning the inbox: a reply arrives, is
        classified

        and stops the cadence identically either way, and only the send path
        differs.
      enum:
        - email
        - linkedin
      title: InboxChannel
      type: string
    StopReason:
      enum:
        - reply
        - unsubscribe
        - bounce
        - manual
        - company_reply
        - row_left_audience
        - step_removed
        - removed
      title: StopReason
      type: string
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - items: {}
              type: array
            - additionalProperties: true
              type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: >-
            The location of the error. Always contains 1 or 2 elements. The
            first element is the type of location (e.g. 'body', 'query', 'path',
            'header'). The second element is the name of the field that caused
            the error. If the error is not related to a specific field, the
            second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: >-
            The type of the error. Useful for frontend code to handle different
            types of errors.
          title: Type
          type: string
      required:
        - loc
        - msg
        - type
        - input
      title: UnprocessableEntityIssue
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey

````