Inbox Zero

Inbox Zero Senders API

The Senders API from Inbox Zero — 1 operation(s) for senders.

Documentation GitHub OpenAPI

Operations 1

POST /senders/unsubscribe Unsubscribe sender #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/getinboxzero-com/openapi/getinboxzero-com-senders-api-openapi.yml

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/getinboxzero-com:getinboxzero-com-senders-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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Inbox Zero Senders API
  version: 1.0.0
  description: 'Programmatic access to Inbox Zero inbox stats, automation rules, and sender unsubscribe. Docs: https://docs.getinboxzero.com/api-reference/introduction Machine-readable schema: /openapi.json Authenticate with an account-scoped API key via the API-Key header. Errors return JSON with error.code, error.message, and error.hint.'
servers:
- url: https://www.getinboxzero.com/api/v1
  description: Primary server
security:
- ApiKeyAuth: []
tags:
- name: Senders
paths:
  /senders/unsubscribe:
    post:
      operationId: unsubscribeSender
      description: 'Unsubscribe from a sender for the scoped inbox. Looks up List-Unsubscribe from that sender''s mail when a link is not provided. Check unsubscribe.success: when it is false the sender was left unchanged.'
      security:
      - ApiKeyAuth:
        - SENDERS_UNSUBSCRIBE
      x-required-scopes:
      - SENDERS_UNSUBSCRIBE
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                senderEmail:
                  type: string
                  format: email
                unsubscribeLink:
                  type: string
                  format: uri
                listUnsubscribeHeader:
                  type: string
                  minLength: 1
              required:
              - senderEmail
      responses:
        '200':
          description: Unsubscribe attempt completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  senderEmail:
                    type: string
                    format: email
                  status:
                    type:
                    - string
                    - 'null'
                    enum:
                    - UNSUBSCRIBED
                    - null
                  unsubscribe:
                    type: object
                    properties:
                      attempted:
                        type: boolean
                      success:
                        type: boolean
                      method:
                        type: string
                        enum:
                        - post
                        - get
                        - form
                        - browser
                      statusCode:
                        type: integer
                      reason:
                        type: string
                        enum:
                        - no_unsubscribe_url
                        - unsafe_unsubscribe_url
                        - request_timeout
                        - request_failed
                        - needs_user
                        - request_rejected
                    required:
                    - attempted
                    - success
                required:
                - senderEmail
                - status
                - unsubscribe
        '400':
          description: Invalid query, path, or request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
        '401':
          description: Missing, invalid, or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
        '403':
          description: API key lacks a required scope or is not account-scoped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
        '405':
          description: HTTP method is not supported for this route
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
        '429':
          description: Rate limited by the API or email provider
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
        '500':
          description: Unexpected server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
      tags:
      - Senders
      summary: Unsubscribe sender
      x-summary-source: derived
components:
  schemas:
    PublicApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - BAD_REQUEST
              - UNAUTHORIZED
              - FORBIDDEN
              - NOT_FOUND
              - METHOD_NOT_ALLOWED
              - RATE_LIMITED
              - INTERNAL_ERROR
            message:
              type: string
            hint:
              type: string
          required:
          - code
          - message
          - hint
      required:
      - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: API-Key
      description: 'Account-scoped API key created in Settings.

        Operations declare the scopes they require.

        Available scopes:

        - RULES_READ: List and inspect automation rules for this inbox.

        - RULES_WRITE: Create, update, and delete automation rules for this inbox.

        - STATS_READ: Read aggregated inbox statistics for this inbox.

        - SENDERS_UNSUBSCRIBE: Unsubscribe from senders for this inbox.'
      x-scopes:
        RULES_READ: List and inspect automation rules for this inbox.
        RULES_WRITE: Create, update, and delete automation rules for this inbox.
        STATS_READ: Read aggregated inbox statistics for this inbox.
        SENDERS_UNSUBSCRIBE: Unsubscribe from senders for this inbox.