Breakreach Inbox API

openapi: 3.2.0
info:
  title: Breakreach Inbox API
  version: 1.1.0
  description: 'Publish and schedule social media posts across Instagram, TikTok, X (Twitter), Reddit, LinkedIn, YouTube, Facebook, Threads, Bluesky, Pinterest, Telegram, Discord, Slack, Mastodon, WordPress, Ghost, Dev.to, Hashnode, Tumblr and Google Business Profile with one request shape.


    Authenticate with an API key (create one in the Breakreach dashboard under Settings → API & MCP) sent as a Bearer token. Errors answer with an HTTP status and a JSON body { "error": "" }.


    Every POST accepts an Idempotency-Key header: any unique string up to 255 characters, a UUID for instance. Retrying with the same key and the same body within 24 hours returns the first response, marked Idempotent-Replayed: true, instead of creating a second post. The same key with a different body answers 422, and 409 while the first request is still running. Errors are not kept, so a fixed request can reuse its key. Keys belong to the API key that sent them.


    AI agents can use the same capabilities through the hosted MCP server at https://api.breakreach.com/mcp (OAuth 2.1).'
servers:
- url: https://api.breakreach.com
security:
- bearerAuth: []
tags:
- name: Inbox
paths:
  /v1/inbox:
    get:
      summary: List direct message conversations
      description: Conversations on connected Facebook Pages (Messenger), Instagram and X accounts, newest first. Accounts whose messages can't be loaded are returned in errors with the reason.
      operationId: listConversations
      parameters:
      - name: platform
        in: query
        schema:
          type: string
          enum:
          - facebook
          - instagram
          - x
      - name: accountId
        in: query
        schema:
          type: string
      - name: workspace
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Unsupported platform or invalid accountId
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Inbox
  /v1/inbox/{conversationId}/messages:
    get:
      summary: Read a conversation
      description: Messages of one conversation, oldest first. participantId is required for X.
      operationId: getConversationMessages
      parameters:
      - name: conversationId
        in: path
        required: true
        schema:
          type: string
      - name: accountId
        in: query
        required: true
        schema:
          type: string
      - name: participantId
        in: query
        schema:
          type: string
      - name: workspace
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Missing or invalid accountId, unsupported platform, or participantId missing for X
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Account or workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: The platform did not return the messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Inbox
    post:
      summary: Send a direct message
      description: Replies in a conversation. Instagram and Messenger only accept replies within 24 hours of the person's last message. participantId is required for X.
      operationId: sendDirectMessage
      parameters:
      - name: conversationId
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - accountId
              - message
              properties:
                accountId:
                  type: string
                message:
                  type: string
                participantId:
                  type: string
                workspace:
                  type: string
      responses:
        '200':
          description: OK
        '400':
          description: Missing message or accountId, unsupported platform, or participantId missing for X
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Account or workspace not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          $ref: '#/components/responses/IdempotencyRunning'
        '422':
          $ref: '#/components/responses/IdempotencyMismatch'
        '502':
          description: The platform rejected the message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Inbox
components:
  responses:
    Unauthorized:
      description: Missing, invalid or expired API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    IdempotencyRunning:
      description: 'A request with this Idempotency-Key is still running: retry after Retry-After seconds to get its response'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PaymentRequired:
      description: No active Breakreach subscription or trial
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    IdempotencyMismatch:
      description: This Idempotency-Key was already used with a different request in the last 24 hours
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Not a member of the requested workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable reason
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 255
      description: 'A unique string for this request, e.g. a UUID. A retry with the same key and body within 24 hours returns the first response (with the header Idempotent-Replayed: true) instead of running again. Printable ASCII, no spaces.'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from the Breakreach dashboard (br_...) or an OAuth access token (bro_...)