> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deliveryman.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Add Suppressed Email

> Adds an address to a workspace's suppression list. Emails to it are rejected until it's removed. Adding an address that's already on the list returns the existing entry.



## OpenAPI

````yaml /openapi.yml post /api/v2/suppression-list/
openapi: 3.1.1
info:
  title: DeliverymanAI API
  version: 2.0.0
  description: >-
    API documentation for DeliverymanAI. Send emails, track their delivery and
    engagement, read replies, verify addresses, manage your suppression list and
    receive webhook events.


    **Strongly recommended:** leave 5 to 10 minutes between emails sent from the
    same domain. Sending many emails from one domain in a short time can hurt
    your domain and IP reputation.


    **Rate limits:** emails from one sending domain go out at least a minimum
    interval apart. If you send sooner, the email is queued and `Send Email`
    returns `202`. Each endpoint also caps how many requests your account can
    make per minute. Over the cap you get `429` with a `Retry-After` header.
    Treat these limits as an upper bound and keep to the gap recommended above.
servers:
  - url: https://api.deliveryman.ai
    description: Deliveryman API Server
security: []
paths:
  /api/v2/suppression-list/:
    post:
      tags:
        - Suppression List
      summary: Add Suppressed Email
      description: >-
        Adds an address to a workspace's suppression list. Emails to it are
        rejected until it's removed. Adding an address that's already on the
        list returns the existing entry.
      operationId: v2_add_suppressed_email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddSuppressionRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddSuppressionRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AddSuppressionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionEntry'
          description: Already Suppressed
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionEntry'
          description: Added
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
          description: Workspace Not Found
        '500':
          description: Internal Server Error
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl -X POST "https://api.deliveryman.ai/api/v2/suppression-list/" \
              -H "X-Api-Key: YOUR_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{
                "email": "alex@draftss.com",
                "workspace_id": 12,
                "type": "unsubscribes"
              }'
components:
  schemas:
    AddSuppressionRequest:
      properties:
        email:
          description: Email address to suppress.
          format: email
          title: Email
          type: string
        workspace_id:
          description: Workspace to add the entry to.
          title: Workspace Id
          type: integer
        type:
          allOf:
            - $ref: '#/components/schemas/TypeEnum'
          default: unsubscribes
          description: >-
            Whether the address is suppressed because it bounced (`bounces`) or
            opted out (`unsubscribes`). Defaults to `unsubscribes`.
          title: Type
      required:
        - email
        - workspace_id
      title: AddSuppressionRequest
      type: object
    SuppressionEntry:
      type: object
      description: An address that emails won't be sent to.
      properties:
        email:
          type: string
          description: Suppressed email address.
        type:
          allOf:
            - $ref: '#/components/schemas/TypeEnum'
          description: '`bounces` if the address bounced, `unsubscribes` if it opted out.'
          readOnly: true
        workspace_id:
          type: integer
          description: Workspace the entry belongs to.
        added_on:
          type: string
          format: date-time
          readOnly: true
          description: When the address was added to the list. ISO 8601, UTC.
      required:
        - added_on
        - email
        - type
        - workspace_id
    MessageResponse:
      type: object
      description: A message describing the result of the request, or what went wrong.
      properties:
        message:
          type: string
          description: Human readable description of the result or error.
      required:
        - message
    TypeEnum:
      enum:
        - bounces
        - unsubscribes
      type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Your API key. In the dashboard, go to Integrations and open Deliveryman
        API Keys to create one.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.