openapi: 3.0.0
info:
  title: Drift Accounts Conversations and Messages API
  description: Drift is a cloud-based solution designed to help businesses automate sales processes by adding live chat windows to websites for increased customer experience and loyalty. Key features include chatbots, geo-targeting, offline access, proactive chating and transfers/routing.
  version: 1.0.0
servers:
- url: http://{{base_url}}
- url: https://driftapi.com
security:
- bearerAuth: []
tags:
- name: Conversations and Messages
  description: '[https://devdocs.drift.com/docs/conversation-model](https://devdocs.drift.com/docs/conversation-model)'
paths:
  /conversations/{id}/messages:
    post:
      tags:
      - Conversations and Messages
      summary: Drift Create a message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                type: string
                body: string
                buttons:
                - value: string
                  label: string
                  type: string
                userId: 0
      parameters:
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: The Drift conversationId
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
      - Conversations and Messages
      summary: Drift Fetch a conversation's messages
      parameters:
      - name: next
        in: query
        schema:
          type: string
        description: Page number where page sizes are always 50
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: The Drift conversationId
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /conversations/{id}:
    get:
      tags:
      - Conversations and Messages
      summary: Drift Fetch a conversation
      parameters:
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: The Drift conversationId
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /conversations/{id}/transcript:
    get:
      tags:
      - Conversations and Messages
      summary: Drift Fetch a conversation's transcript as a string
      parameters:
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: The Drift conversationId
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /conversations/{id}/json_transcript:
    get:
      tags:
      - Conversations and Messages
      summary: Drift Fetch a conversation's transcript as a JSON object
      parameters:
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: The Drift conversationId
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /attachments/{id}/data:
    get:
      tags:
      - Conversations and Messages
      summary: Drift Fetch a conversation's attachments
      parameters:
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: The Drift documentId
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /conversations/new:
    post:
      tags:
      - Conversations and Messages
      summary: Drift Create a conversation
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                email: string
                message:
                  body: string
                  attributes: {}
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /conversations/stats:
    get:
      tags:
      - Conversations and Messages
      summary: Drift List conversation statuses
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /conversations/list:
    get:
      tags:
      - Conversations and Messages
      summary: Drift List conversations
      parameters:
      - name: limit
        in: query
        schema:
          type: string
        description: Max number of conversations to retrieve (max 100, default 25).
      - name: statusId
        in: query
        schema:
          type: string
        description: 'Return only conversations that match the provided status code. Uses the following values: OPEN, CLOSED, PENDING'
      - name: page_token
        in: query
        schema:
          type: string
        description: Allows you to move to the next page
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer