addy.io Failed Deliveries API

The Failed Deliveries API from addy.io — 5 operation(s) for failed deliveries.

Business capability
Email AE-150.10

Operations 6

GET /api/v1/failed-deliveries Get All Failed Deliveries #
GET /api/v1/failed-deliveries/{id} Get a Specific Failed Delivery #
DELETE /api/v1/failed-deliveries/{id} Delete a Specific Failed Delivery #
POST /api/v1/failed-deliveries/delete/bulk Bulk Delete Failed Deliveries #
GET /api/v1/failed-deliveries/{id}/download Download a Specific Failed Delivery #
POST /api/v1/failed-deliveries/{id}/resend Resend a Specific Failed Delivery #

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/addy-io:addy-io-failed-deliveries-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

addy-io-failed-deliveries-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: addy.io API Documentation Failed Deliveries API
  description: ''
  version: 1.0.0
servers:
- url: https://app.addy.io
security:
- default: []
tags:
- name: Failed Deliveries
  description: ''
paths:
  /api/v1/failed-deliveries:
    get:
      summary: Get All Failed Deliveries
      operationId: getAllFailedDeliveries
      description: This endpoint retrieves all failed deliveries.
      parameters:
      - in: query
        name: filter[email_type]
        description: 'Filter by email type. Options: inbound, outbound, inbound_quarantined.'
        example: inbound
        required: false
        schema:
          type: string
          description: 'Filter by email type. Options: inbound, outbound, inbound_quarantined.'
          example: inbound
      - in: query
        name: page[number]
        description: Paginate the results.
        example: 1
        required: false
        schema:
          type: integer
          description: Paginate the results.
          example: 1
      - in: query
        name: page[size]
        description: Paginate the results, default 100, min 1 max 100.
        example: 25
        required: false
        schema:
          type: integer
          description: Paginate the results, default 100, min 1 max 100.
          example: 25
      - in: header
        name: X-Requested-With
        description: ''
        example: XMLHttpRequest
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                  - id: 0222b9fe-59d0-4066-a711-c44ad42f1734
                    user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
                    recipient_id: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                    recipient_email: user@recipient.com
                    alias_id: 50c9e585-e7f5-41c4-9016-9014c15454bc
                    alias_email: alias@anonaddy.com
                    alias_description: Newsletter signup
                    bounce_type: spam
                    remote_mta: mail.icloud.com
                    sender: sender@example.com
                    type: outbound
                    email_type: F
                    email_type_text: Forward
                    status: 5.7.1
                    code: smtp; 554 5.7.1 [CS01] Message rejected due to local policy. Please visit https://support.apple.com/en-us/HT204137
                    is_stored: true
                    quarantined: false
                    resent: false
                    attempted_at: '2019-10-01 09:00:00'
                    created_at: '2019-10-01 09:00:00'
                    updated_at: '2019-10-01 09:00:00'
                  - id: f6d1cfe6-46b6-4068-5881-b7cd07dac8a2
                    user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
                    recipient_id: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                    recipient_email: user@recipient.com
                    alias_id: 50c9e585-e7f5-41c4-9016-9014c15454bc
                    alias_email: alias@anonaddy.com
                    alias_description: Newsletter signup
                    bounce_type: hard
                    remote_mta: mail.example.com
                    sender: sender@example.com
                    type: outbound
                    email_type: F
                    email_type_text: Forward
                    status: 5.7.1
                    code: 'smtp; 550 5.7.1 <does-not-exist@example.com>: Recipient address rejected: Recipient not found'
                    is_stored: false
                    quarantined: false
                    resent: false
                    attempted_at: '2019-10-01 09:00:00'
                    created_at: '2019-10-01 09:00:00'
                    updated_at: '2019-10-01 09:00:00'
                properties:
                  data:
                    type: array
                    example:
                    - id: 0222b9fe-59d0-4066-a711-c44ad42f1734
                      user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
                      recipient_id: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                      recipient_email: user@recipient.com
                      alias_id: 50c9e585-e7f5-41c4-9016-9014c15454bc
                      alias_email: alias@anonaddy.com
                      alias_description: Newsletter signup
                      bounce_type: spam
                      remote_mta: mail.icloud.com
                      sender: sender@example.com
                      type: outbound
                      email_type: F
                      email_type_text: Forward
                      status: 5.7.1
                      code: smtp; 554 5.7.1 [CS01] Message rejected due to local policy. Please visit https://support.apple.com/en-us/HT204137
                      is_stored: true
                      quarantined: false
                      resent: false
                      attempted_at: '2019-10-01 09:00:00'
                      created_at: '2019-10-01 09:00:00'
                      updated_at: '2019-10-01 09:00:00'
                    - id: f6d1cfe6-46b6-4068-5881-b7cd07dac8a2
                      user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
                      recipient_id: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                      recipient_email: user@recipient.com
                      alias_id: 50c9e585-e7f5-41c4-9016-9014c15454bc
                      alias_email: alias@anonaddy.com
                      alias_description: Newsletter signup
                      bounce_type: hard
                      remote_mta: mail.example.com
                      sender: sender@example.com
                      type: outbound
                      email_type: F
                      email_type_text: Forward
                      status: 5.7.1
                      code: 'smtp; 550 5.7.1 <does-not-exist@example.com>: Recipient address rejected: Recipient not found'
                      is_stored: false
                      quarantined: false
                      resent: false
                      attempted_at: '2019-10-01 09:00:00'
                      created_at: '2019-10-01 09:00:00'
                      updated_at: '2019-10-01 09:00:00'
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 0222b9fe-59d0-4066-a711-c44ad42f1734
                        user_id:
                          type: string
                          example: ca0a4e09-c266-4f6f-845c-958db5090f09
                        recipient_id:
                          type: string
                          example: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                        recipient_email:
                          type: string
                          example: user@recipient.com
                        alias_id:
                          type: string
                          example: 50c9e585-e7f5-41c4-9016-9014c15454bc
                        alias_email:
                          type: string
                          example: alias@anonaddy.com
                        alias_description:
                          type: string
                          example: Newsletter signup
                        bounce_type:
                          type: string
                          example: spam
                        remote_mta:
                          type: string
                          example: mail.icloud.com
                        sender:
                          type: string
                          example: sender@example.com
                        type:
                          type: string
                          example: outbound
                        email_type:
                          type: string
                          example: F
                        email_type_text:
                          type: string
                          example: Forward
                        status:
                          type: string
                          example: 5.7.1
                        code:
                          type: string
                          example: smtp; 554 5.7.1 [CS01] Message rejected due to local policy. Please visit https://support.apple.com/en-us/HT204137
                        is_stored:
                          type: boolean
                          example: true
                        quarantined:
                          type: boolean
                          example: false
                        resent:
                          type: boolean
                          example: false
                        attempted_at:
                          type: string
                          example: '2019-10-01 09:00:00'
                        created_at:
                          type: string
                          example: '2019-10-01 09:00:00'
                        updated_at:
                          type: string
                          example: '2019-10-01 09:00:00'
      tags:
      - Failed Deliveries
  /api/v1/failed-deliveries/{id}:
    parameters:
    - in: path
      name: id
      description: The id of the failed delivery to retrieve
      example: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
      required: true
      schema:
        type: string
    get:
      summary: Get a Specific Failed Delivery
      operationId: getASpecificFailedDelivery
      description: This endpoint retrieves a specific failed delivery.
      parameters:
      - in: header
        name: X-Requested-With
        description: ''
        example: XMLHttpRequest
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 0222b9fe-59d0-4066-a711-c44ad42f1734
                    user_id: ca0a4e09-c266-4f6f-845c-958db5090f09
                    recipient_id: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                    recipient_email: user@recipient.com
                    alias_id: 50c9e585-e7f5-41c4-9016-9014c15454bc
                    alias_email: alias@anonaddy.com
                    alias_description: Newsletter signup
                    bounce_type: spam
                    remote_mta: mail.icloud.com
                    sender: sender@example.com
                    type: outbound
                    email_type: F
                    email_type_text: Forward
                    status: 5.7.1
                    code: smtp; 554 5.7.1 [CS01] Message rejected due to local policy. Please visit https://support.apple.com/en-us/HT204137
                    is_stored: true
                    quarantined: false
                    resent: false
                    attempted_at: '2019-10-01 09:00:00'
                    created_at: '2019-10-01 09:00:00'
                    updated_at: '2019-10-01 09:00:00'
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 0222b9fe-59d0-4066-a711-c44ad42f1734
                      user_id:
                        type: string
                        example: ca0a4e09-c266-4f6f-845c-958db5090f09
                      recipient_id:
                        type: string
                        example: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                      recipient_email:
                        type: string
                        example: user@recipient.com
                      alias_id:
                        type: string
                        example: 50c9e585-e7f5-41c4-9016-9014c15454bc
                      alias_email:
                        type: string
                        example: alias@anonaddy.com
                      alias_description:
                        type: string
                        example: Newsletter signup
                      bounce_type:
                        type: string
                        example: spam
                      remote_mta:
                        type: string
                        example: mail.icloud.com
                      sender:
                        type: string
                        example: sender@example.com
                      type:
                        type: string
                        example: outbound
                      email_type:
                        type: string
                        example: F
                      email_type_text:
                        type: string
                        example: Forward
                      status:
                        type: string
                        example: 5.7.1
                      code:
                        type: string
                        example: smtp; 554 5.7.1 [CS01] Message rejected due to local policy. Please visit https://support.apple.com/en-us/HT204137
                      is_stored:
                        type: boolean
                        example: true
                      quarantined:
                        type: boolean
                        example: false
                      resent:
                        type: boolean
                        example: false
                      attempted_at:
                        type: string
                        example: '2019-10-01 09:00:00'
                      created_at:
                        type: string
                        example: '2019-10-01 09:00:00'
                      updated_at:
                        type: string
                        example: '2019-10-01 09:00:00'
      tags:
      - Failed Deliveries
    delete:
      summary: Delete a Specific Failed Delivery
      operationId: deleteASpecificFailedDelivery
      description: This endpoint deletes a specific failed delivery.
      parameters:
      - in: header
        name: X-Requested-With
        description: ''
        example: XMLHttpRequest
        schema:
          type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example: {}
                properties: {}
      tags:
      - Failed Deliveries
  /api/v1/failed-deliveries/delete/bulk:
    post:
      summary: Bulk Delete Failed Deliveries
      operationId: bulkDeleteFailedDeliveries
      description: This endpoint deletes specific failed deliveries.
      parameters:
      - in: header
        name: X-Requested-With
        description: ''
        example: XMLHttpRequest
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 3 failed deliveries deleted successfully
                  ids:
                  - '...'
                properties:
                  message:
                    type: string
                    example: 3 failed deliveries deleted successfully
                  ids:
                    type: array
                    example:
                    - '...'
                    items:
                      type: string
      tags:
      - Failed Deliveries
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: An array of failed delivery ids (max 100).
                  example:
                  - 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                  items:
                    type: string
              required:
              - ids
  /api/v1/failed-deliveries/{id}/download:
    parameters:
    - in: path
      name: id
      description: The id of the failed delivery to retrieve
      example: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
      required: true
      schema:
        type: string
    get:
      summary: Download a Specific Failed Delivery
      operationId: downloadASpecificFailedDelivery
      description: This endpoint downloads a specific failed delivery.
      parameters:
      - in: header
        name: X-Requested-With
        description: ''
        example: XMLHttpRequest
        schema:
          type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example: {}
                properties: {}
      tags:
      - Failed Deliveries
  /api/v1/failed-deliveries/{id}/resend:
    parameters:
    - in: path
      name: id
      description: The id of the failed delivery to resend
      example: 46eebc50-f7f8-46d7-beb9-c37f04c29a84
      required: true
      schema:
        type: string
    post:
      summary: Resend a Specific Failed Delivery
      operationId: resendASpecificFailedDelivery
      description: This endpoint resends a specific failed delivery.
      parameters:
      - in: header
        name: X-Requested-With
        description: ''
        example: XMLHttpRequest
        schema:
          type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example: {}
                properties: {}
      tags:
      - Failed Deliveries
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                recipient_ids:
                  type: array
                  description: An array of recipient ids to resend to, max 10 (the default alias recipient(s) will be used if none are provided)
                  example:
                  - 46eebc50-f7f8-46d7-beb9-c37f04c29a84
                  items:
                    type: string
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: You can retrieve your API key by visiting your <a href="https://app.addy.io/settings/api">account settings</a> and clicking <b>Create New API Key</b>.