Outreach2day Warmup API

The Warmup API from Outreach2day — 3 operation(s) for warmup.

GitHub OpenAPI

Operations 3

POST /warmup/operations Public Create Warmup Operation #
GET /warmup/operations/{operation_id} Public Get Warmup Operation #
GET /warmup/mailboxes Public List Warmup Mailboxes #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/outreach2day-com:outreach2day-com-warmup-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

outreach2day-com-warmup-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Outreach2day Com Warmup API
  version: v1
  description: 'Operations tagged Warmup across 2 of this provider''s published API definitions: public.json, outreach2day-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://public.outreach2day.com
  description: Production
tags:
- name: Warmup
paths:
  /warmup/operations:
    post:
      tags:
      - Warmup
      summary: Public Create Warmup Operation
      description: Warmup endpoint for POST /warmup/operations.
      operationId: public_create_warmup_operation_warmup_operations_post
      security:
      - HTTPBearer: []
      parameters:
      - name: workspaceId
        in: query
        required: true
        schema:
          type: integer
          title: Workspaceid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WarmupOperationCreateIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarmupOperationOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /warmup/operations/{operation_id}:
    get:
      tags:
      - Warmup
      summary: Public Get Warmup Operation
      description: Warmup endpoint for GET /warmup/operations/{operation_id}.
      operationId: public_get_warmup_operation_warmup_operations__operation_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          title: Operation Id
      - name: workspaceId
        in: query
        required: true
        schema:
          type: integer
          title: Workspaceid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WarmupOperationOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
  /warmup/mailboxes:
    get:
      tags:
      - Warmup
      summary: Public List Warmup Mailboxes
      description: Warmup endpoint for GET /warmup/mailboxes.
      operationId: public_list_warmup_mailboxes_warmup_mailboxes_get
      security:
      - HTTPBearer: []
      parameters:
      - name: workspaceId
        in: query
        required: true
        schema:
          type: integer
          title: Workspaceid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/WarmupMailboxStateOut'
                title: Response Public List Warmup Mailboxes Warmup Mailboxes Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      servers:
      - url: https://public.outreach2day.com
        description: Production
    servers:
    - url: https://public.outreach2day.com
      description: Production
components:
  schemas:
    WarmupOperationItemOut:
      properties:
        mailboxId:
          type: integer
          title: Mailboxid
        mailbox:
          type: string
          title: Mailbox
        status:
          $ref: '#/components/schemas/WarmupItemStatus'
        errorCode:
          anyOf:
          - type: string
          - type: 'null'
          title: Errorcode
        errorRef:
          anyOf:
          - type: string
          - type: 'null'
          title: Errorref
        queuedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Queuedat
        startedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Startedat
        completedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completedat
      type: object
      required:
      - mailboxId
      - mailbox
      - status
      title: WarmupOperationItemOut
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    WarmupItemStatus:
      type: string
      enum:
      - requested
      - accepted
      - processing
      - ack_pending
      - completed
      - partial
      - failed
      - cancelled
      - failed_timeout
      - needs_reconciliation
      title: WarmupItemStatus
    MailboxExplicitTargetIn:
      properties:
        mode:
          type: string
          const: explicit
          title: Mode
          default: explicit
        mailboxIds:
          items:
            type: integer
          type: array
          title: Mailboxids
        mailboxes:
          items:
            type: string
          type: array
          title: Mailboxes
      type: object
      title: MailboxExplicitTargetIn
    MailboxAllFilteredTargetIn:
      properties:
        mode:
          type: string
          const: all_filtered
          title: Mode
          default: all_filtered
        filters:
          $ref: '#/components/schemas/MailboxInventoryFiltersIn'
        excludedMailboxIds:
          items:
            type: integer
          type: array
          title: Excludedmailboxids
        excludedMailboxes:
          items:
            type: string
          type: array
          title: Excludedmailboxes
      type: object
      title: MailboxAllFilteredTargetIn
    WarmupOperationOut:
      properties:
        operationId:
          type: string
          title: Operationid
        status:
          $ref: '#/components/schemas/WarmupOperationStatus'
        action:
          $ref: '#/components/schemas/WarmupAction'
        workspaceId:
          type: integer
          title: Workspaceid
        requestedCount:
          type: integer
          title: Requestedcount
        prevalidatedCount:
          type: integer
          title: Prevalidatedcount
          default: 0
        acceptedCount:
          type: integer
          title: Acceptedcount
        rejectedCount:
          type: integer
          title: Rejectedcount
        successCount:
          type: integer
          title: Successcount
        failureCount:
          type: integer
          title: Failurecount
        rejections:
          items:
            $ref: '#/components/schemas/WarmupRejection'
          type: array
          title: Rejections
        queuedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Queuedat
        startedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Startedat
        completedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Completedat
        items:
          items:
            $ref: '#/components/schemas/WarmupOperationItemOut'
          type: array
          title: Items
      type: object
      required:
      - operationId
      - status
      - action
      - workspaceId
      - requestedCount
      - acceptedCount
      - rejectedCount
      - successCount
      - failureCount
      title: WarmupOperationOut
    WarmupAction:
      type: string
      enum:
      - enable
      - pause
      - disable
      - remove
      title: WarmupAction
    WarmupRejection:
      properties:
        mailbox:
          type: string
          title: Mailbox
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      type: object
      required:
      - mailbox
      - code
      - message
      title: WarmupRejection
    WarmupMailboxStateOut:
      properties:
        mailboxId:
          type: integer
          title: Mailboxid
        mailbox:
          type: string
          title: Mailbox
        mailboxStatus:
          type: string
          title: Mailboxstatus
        warmupState:
          $ref: '#/components/schemas/ClientWarmupState'
        warmupStateReason:
          anyOf:
          - type: string
            enum:
            - observation_stale
            - observation_future
          - type: 'null'
          title: Warmupstatereason
        warmupEnabled:
          type: boolean
          title: Warmupenabled
        warmupQueuePending:
          type: boolean
          title: Warmupqueuepending
          default: false
          deprecated: true
        warmupStartedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Warmupstartedat
        observedWarmupStartedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Observedwarmupstartedat
        warmupPausedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Warmuppausedat
        warmupObservedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Warmupobservedat
        latestOperationId:
          anyOf:
          - type: string
          - type: 'null'
          title: Latestoperationid
        latestOperationStatus:
          anyOf:
          - type: string
          - type: 'null'
          title: Latestoperationstatus
        latestItemStatus:
          anyOf:
          - type: string
          - type: 'null'
          title: Latestitemstatus
        latestCheck:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Latestcheck
      type: object
      required:
      - mailboxId
      - mailbox
      - mailboxStatus
      - warmupState
      - warmupEnabled
      title: WarmupMailboxStateOut
    MailboxInventoryFiltersIn:
      properties:
        search:
          anyOf:
          - type: string
          - type: 'null'
          title: Search
        status:
          items:
            type: string
          type: array
          title: Status
        warmupState:
          items:
            $ref: '#/components/schemas/ClientWarmupState'
          type: array
          title: Warmupstate
        tagId:
          items:
            type: string
          type: array
          title: Tagid
        domainId:
          items:
            type: integer
          type: array
          title: Domainid
        sortBy:
          anyOf:
          - type: string
          - type: 'null'
          title: Sortby
        sortDir:
          anyOf:
          - type: string
            enum:
            - asc
            - desc
          - type: 'null'
          title: Sortdir
      type: object
      title: MailboxInventoryFiltersIn
    ClientWarmupState:
      type: string
      enum:
      - not_started
      - warming
      - paused
      - error
      - disabled
      title: ClientWarmupState
    WarmupOperationCreateIn:
      properties:
        action:
          $ref: '#/components/schemas/WarmupAction'
        mailboxes:
          items:
            type: string
          type: array
          title: Mailboxes
        target:
          anyOf:
          - oneOf:
            - $ref: '#/components/schemas/MailboxExplicitTargetIn'
            - $ref: '#/components/schemas/MailboxAllFilteredTargetIn'
            discriminator:
              propertyName: mode
              mapping:
                all_filtered: '#/components/schemas/MailboxAllFilteredTargetIn'
                explicit: '#/components/schemas/MailboxExplicitTargetIn'
          - type: 'null'
          title: Target
        idempotencyKey:
          type: string
          maxLength: 128
          minLength: 8
          title: Idempotencykey
      type: object
      required:
      - action
      - idempotencyKey
      title: WarmupOperationCreateIn
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WarmupOperationStatus:
      type: string
      enum:
      - requested
      - processing
      - accepted
      - completed
      - partial
      - failed
      - failed_timeout
      - needs_reconciliation
      title: WarmupOperationStatus
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- public.json
- outreach2day-com-openapi.json
x-provenance:
  method: harvested
  publisher: Outreach2day
  source: https://public.outreach2day.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)