Outreach2day Mailboxes API
The Mailboxes API from Outreach2day — 3 operation(s) for mailboxes.
The Mailboxes API from Outreach2day — 3 operation(s) for mailboxes.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/outreach2day-com:outreach2day-com-mailboxes-api"
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.
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: 3.2.0
info:
title: Outreach2day Com Mailboxes API
version: v1
description: 'Operations tagged Mailboxes 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: Mailboxes
paths:
/mailboxes:
get:
tags:
- Mailboxes
summary: List Mailboxes
description: 'List all mailboxes for a user or a specific workspace.
- If workspace_id is provided, it will return mailboxes for that specific workspace.
- If workspace_id is not provided, it will return mailboxes for all workspaces of the user.'
operationId: list_mailboxes_mailboxes_get
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: query
required: true
schema:
type: integer
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MailboxInfo'
title: Response List Mailboxes Mailboxes Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
servers:
- url: https://public.outreach2day.com
description: Production
delete:
tags:
- Mailboxes
summary: Delete Mailboxes
description: Delete multiple mailboxes by their addresses.
operationId: delete_mailboxes_mailboxes_delete
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: string
title: Addresses
responses:
'202':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
servers:
- url: https://public.outreach2day.com
description: Production
post:
tags:
- Mailboxes
summary: Create Mailboxes
description: Create mailbox records through the deprecated v1 response contract.
operationId: create_mailboxes_mailboxes_post
deprecated: true
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: query
required: true
schema:
type: integer
title: Workspace Id
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailboxRequest'
title: Mailboxes
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'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
/v2/mailboxes:
post:
tags:
- Mailboxes
summary: Create Mailboxes V2
description: Save local mailbox records without claiming provider setup or completion.
operationId: create_mailboxes_v2_v2_mailboxes_post
security:
- HTTPBearer: []
parameters:
- name: workspaceId
in: query
required: true
schema:
type: integer
title: Workspaceid
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateMailboxRequest'
title: Mailboxes
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PublicMailboxAdmissionV2Out'
'402':
description: Payment required. Create a quote (POST /v2/quotes), show it to the human and let them pay on the Stripe page; nothing was charged.
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentRequiredOut'
'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
/update_mailboxes:
post:
tags:
- Mailboxes
summary: Update Mailboxes Handler
description: Update information for multiple mailboxes.
operationId: update_mailboxes_handler_update_mailboxes_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMailboxesIn'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
servers:
- url: https://public.outreach2day.com
description: Production
servers:
- url: https://public.outreach2day.com
description: Production
components:
schemas:
CreateMailboxRequest:
properties:
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
address:
type: string
title: Address
domain_id:
type: integer
title: Domain Id
password:
type: string
title: Password
type: object
required:
- first_name
- last_name
- address
- domain_id
- password
title: CreateMailboxRequest
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
PaymentRequiredOut:
properties:
detail:
$ref: '#/components/schemas/PaymentRequiredDetail'
type: object
required:
- detail
title: PaymentRequiredOut
PublicMailboxAdmissionV2Out:
properties:
status:
type: string
const: accepted
title: Status
outcome:
type: string
const: local_records_saved
title: Outcome
workspaceId:
type: integer
title: Workspaceid
requestedCount:
type: integer
title: Requestedcount
acceptedCount:
type: integer
title: Acceptedcount
providerSetup:
$ref: '#/components/schemas/PublicMailboxProviderSetupV2Out'
operationId:
type: 'null'
title: Operationid
statusUrl:
type: 'null'
title: Statusurl
message:
type: string
const: Mailbox local records saved; provider setup not scheduled
title: Message
next_action:
type: string
const: create_quote
title: Next Action
description: Provider setup is not scheduled by this call; mailboxes are created automatically after an order is paid.
default: create_quote
next_step:
type: string
title: Next Step
links:
additionalProperties:
type: string
type: object
title: Links
type: object
required:
- status
- outcome
- workspaceId
- requestedCount
- acceptedCount
- providerSetup
- operationId
- statusUrl
- message
- next_step
- links
title: PublicMailboxAdmissionV2Out
UpdateMailboxesIn:
properties:
mailboxes:
items:
type: string
type: array
title: Mailboxes
firstName:
type: string
title: Firstname
lastName:
type: string
title: Lastname
signature:
anyOf:
- type: string
- type: 'null'
title: Signature
forwardTo:
anyOf:
- type: string
- type: 'null'
title: Forwardto
default: ''
workspace_id:
anyOf:
- type: integer
- type: 'null'
title: Workspace Id
type: object
required:
- mailboxes
- firstName
- lastName
- signature
title: UpdateMailboxesIn
PaymentRequiredLinks:
properties:
pricing:
type: string
title: Pricing
quote_api:
type: string
title: Quote Api
docs:
type: string
title: Docs
type: object
required:
- pricing
- quote_api
- docs
title: PaymentRequiredLinks
PaymentRequiredDetail:
properties:
error:
type: string
title: Error
description: Stable error code, unchanged from earlier versions (e.g. PAYMENT_METHOD_REQUIRED, PAYMENT_SUBSCRIPTION_REQUIRED, PAYMENT_REQUIRED, MAILBOXES_LIMIT_REACHED).
message:
type: string
title: Message
next_action:
type: string
title: Next Action
description: Always `create_quote`.
default: create_quote
next_step:
type: string
title: Next Step
links:
$ref: '#/components/schemas/PaymentRequiredLinks'
additionalProperties: true
type: object
required:
- error
- message
- next_step
- links
title: PaymentRequiredDetail
MailboxInfo:
properties:
id:
type: integer
title: Id
first_name:
anyOf:
- type: string
- type: 'null'
title: First Name
last_name:
anyOf:
- type: string
- type: 'null'
title: Last Name
address:
anyOf:
- type: string
- type: 'null'
title: Address
domain_id:
anyOf:
- type: integer
- type: 'null'
title: Domain Id
status:
anyOf:
- type: string
- type: 'null'
title: Status
default: init
password:
anyOf:
- type: string
- type: 'null'
title: Password
forward_to:
anyOf:
- type: string
- type: 'null'
title: Forward To
signature:
anyOf:
- type: string
- type: 'null'
title: Signature
enable_forwarding:
anyOf:
- type: boolean
- type: 'null'
title: Enable Forwarding
default: false
type: object
required:
- id
- first_name
- last_name
- address
- domain_id
- password
- forward_to
- signature
title: MailboxInfo
PublicMailboxProviderSetupV2Out:
properties:
state:
type: string
const: not_scheduled
title: State
type: object
required:
- state
title: PublicMailboxProviderSetupV2Out
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
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)