openapi: 3.0.3
info:
  title: Postmaster+
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://postmasterplus.app'
paths:
  '/api/v1/intelligence/single-emails/{email}':
    get:
      summary: 'Retrieve Single Email.'
      operationId: retrieveSingleEmail
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 19
                    email: example@postmasterplus.com
                    status: Deliverable
                    created_at: '2025-01-29 16:13:54'
                    updated_at: '2025-01-29 16:14:13'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 19
                      email:
                        type: string
                        example: example@postmasterplus.com
                      status:
                        type: string
                        example: Deliverable
                      created_at:
                        type: string
                        example: '2025-01-29 16:13:54'
                      updated_at:
                        type: string
                        example: '2025-01-29 16:14:13'
      tags:
        - Intelligence
    delete:
      summary: 'Delete Single Email.'
      operationId: deleteSingleEmail
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Single email deleted.'
                  deleted: true
                properties:
                  message:
                    type: string
                    example: 'Single email deleted.'
                  deleted:
                    type: boolean
                    example: true
      tags:
        - Intelligence
    parameters:
      -
        in: path
        name: email
        description: 'The email address to retrieve.'
        example: example@postmasterplus.com
        required: true
        schema:
          type: string
  /api/v1/intelligence/single-emails/scan:
    post:
      summary: 'Scan Single Email.'
      operationId: scanSingleEmail
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Intelligence
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  description: 'The email address to scan.'
                  example: example@postmasterplus.com
                  nullable: false
                actions:
                  type: string
                  description: 'The actions in comma separated format to perform.'
                  example: '"verification,activity,postal_append"'
                  nullable: false
              required:
                - email
                - actions
tags:
  -
    name: Intelligence
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>Team Settings > API Tokens</b>.'
security:
  -
    default: []