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

# Create a deal



## OpenAPI

````yaml /public/openapi.json post /deals
openapi: 3.1.0
info:
  title: OutReign API
  version: 1.0.0
  summary: B2B lead intelligence and outbound sales API
  description: >-
    REST API for OutReign saved leads, deals, activities, contacts and AI email
    generation. Authenticate with X-API-Key from Settings → API Keys. MCP OAuth
    and webhook contracts are documented separately at https://docs.outreign.io.
  contact:
    name: OutReign support
    email: support@bdotindustries.com
    url: https://outreign.io/connect
  termsOfService: https://outreign.io/terms
servers:
  - url: https://api.outreign.io/rest-api
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Leads
  - name: Deals
  - name: Activities
  - name: Contacts
  - name: Outreach
externalDocs:
  description: Human API documentation
  url: https://docs.outreign.io
paths:
  /deals:
    post:
      tags:
        - Deals
      summary: Create a deal
      operationId: createDeal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DealInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Deal'
        '401':
          description: Missing, invalid, inactive or expired API key
        '403':
          description: Account plan or access restriction
        '429':
          description: Rate limit exceeded; inspect resetAt and rate-limit headers
components:
  schemas:
    DealInput:
      type: object
      properties:
        title:
          type: string
        company_name:
          type: string
        contact_name:
          type: string
        stage:
          type: string
        value:
          type: number
        probability:
          type: integer
          minimum: 0
          maximum: 100
        expected_close_date:
          type: string
          format: date
        notes:
          type: string
        lead_id:
          type: string
          format: uuid
      additionalProperties: false
      required:
        - title
        - company_name
    Deal:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        title:
          type: string
        company_name:
          type: string
        value:
          type: number
        stage:
          type: string
        probability:
          type: integer
          minimum: 0
          maximum: 100
        contact_name:
          type: string
        expected_close_date:
          type: string
          format: date
        notes:
          type: string
        lead_id:
          type: string
          format: uuid
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Create keys in OutReign → Settings → API Keys.

````

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