NudgeLink Mailboxes API

The mailboxes API from NudgeLink — 3 operation(s) for mailboxes.

GitHub OpenAPI

Operations 4

GET /api/v1/mailboxes List Mailboxes #
POST /api/v1/mailboxes/connect Connect Mailbox #
PATCH /api/v1/mailboxes/{mailbox_id} Update Mailbox #
DELETE /api/v1/mailboxes/{mailbox_id} Disconnect Mailbox #

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/nudgelink-co:nudgelink-co-mailboxes-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

nudgelink-co-mailboxes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Mailboxes API
  version: 0.1.0
tags:
- name: mailboxes
paths:
  /api/v1/mailboxes:
    get:
      tags:
      - mailboxes
      summary: List Mailboxes
      operationId: list_mailboxes_api_v1_mailboxes_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailboxList'
      security:
      - HTTPBearer: []
  /api/v1/mailboxes/connect:
    post:
      tags:
      - mailboxes
      summary: Connect Mailbox
      operationId: connect_mailbox_api_v1_mailboxes_connect_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__api__mailboxes__ConnectOut'
      security:
      - HTTPBearer: []
  /api/v1/mailboxes/{mailbox_id}:
    patch:
      tags:
      - mailboxes
      summary: Update Mailbox
      operationId: update_mailbox_api_v1_mailboxes__mailbox_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: mailbox_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Mailbox Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MailboxPatch'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MailboxOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - mailboxes
      summary: Disconnect Mailbox
      description: 'Works without a plan: a downgraded client can still remove a mailbox.

        It stops sending at once, even if Unipile is unreachable.


        Release review 2026-10-13 (DB-1 / DB-2 / DB-6 / EMAIL-6): the row is kept

        (``disconnected``) instead of deleted, so every email already sent from it

        keeps its ``mailbox_id`` and replies/bounces to it still match — and a

        reconnect of the same address reuses the row. If Unipile''s delete fails

        the row stays ``disconnecting`` with its account id, and

        ``tasks/mailboxes.retry_disconnects`` retries until Unipile lets go.'
      operationId: disconnect_mailbox_api_v1_mailboxes__mailbox_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: mailbox_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Mailbox Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MailboxOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        provider:
          type: string
          title: Provider
        address:
          type: string
          title: Address
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
        status:
          type: string
          title: Status
        paired_seat_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Paired Seat Id
        daily_cap:
          type: integer
          title: Daily Cap
        cap_today:
          type: integer
          title: Cap Today
        created_at:
          type: string
          format: date-time
          title: Created At
        last_error:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Error
      type: object
      required:
      - id
      - provider
      - address
      - display_name
      - status
      - paired_seat_id
      - daily_cap
      - cap_today
      - created_at
      title: MailboxOut
    app__api__mailboxes__ConnectOut:
      properties:
        url:
          type: string
          title: Url
      type: object
      required:
      - url
      title: ConnectOut
    MailboxList:
      properties:
        mailboxes:
          items:
            $ref: '#/components/schemas/MailboxOut'
          type: array
          title: Mailboxes
        limit:
          type: integer
          title: Limit
        can_add:
          type: boolean
          title: Can Add
      type: object
      required:
      - mailboxes
      - limit
      - can_add
      title: MailboxList
    MailboxPatch:
      properties:
        paired_seat_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Paired Seat Id
        daily_cap:
          anyOf:
          - type: integer
            maximum: 100.0
            minimum: 1.0
          - type: 'null'
          title: Daily Cap
      type: object
      title: MailboxPatch
      description: 'Omit a field to leave it; ``paired_seat_id: null`` unpairs.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer