eusend-dev Suppressions API

openapi: 3.2.0
info:
  title: eusend Suppressions API
  version: 1.0.0
  summary: EU-native transactional and marketing email API.
  description: 'eusend sends transactional and marketing email from infrastructure that stays inside the European Union — processing, storage and delivery alike.


    **When to use this API.** Reach for eusend to send application email from server-side code: password resets, receipts, verification codes, notifications, and opt-in marketing broadcasts to a list you own. It is a good fit when GDPR or EU data residency is a requirement, when you are migrating off Resend, SendGrid, Mailgun, Postmark or SES, or when you need SMTP relay rather than an HTTP call. It is not a fit for inbox hosting, for reading a user’s mailbox, or for sending to purchased or scraped lists.


    **Getting started.** Create an account, verify a sending domain by publishing the DNS records the domain endpoints hand back, then `POST /emails`. A key prefixed `eu_test_` exercises the whole pipeline without delivering anything.


    **Authentication.** Every authenticated endpoint takes `Authorization: Bearer `. Keys are `eu_live_…` or `eu_test_…`, and carry either `full_access` or the send-only `sending_access` permission.


    **Errors.** Non-2xx responses are always `{ "error": string, "code": string }`. Branch on `code`; the list is enumerated on the `Error` schema.


    **Conventions.** Request bodies use snake_case and reject unknown properties. Response bodies use camelCase, except the pagination cursor and a handful of endpoints noted inline. List endpoints are cursor-paginated, newest first. Every response carries `X-Request-Id`.'
  termsOfService: https://eusend.dev/legal/terms
  contact:
    name: eusend support
    email: support@eusend.dev
    url: https://eusend.dev/support
  license:
    name: Proprietary
    url: https://eusend.dev/legal/terms
servers:
- url: https://api.eusend.dev
  description: Production
security:
- bearerAuth: []
tags:
- name: Suppressions
  description: Addresses this organization will not send to.
paths:
  /suppressions:
    get:
      operationId: listSuppressions
      summary: List suppressed addresses
      description: The addresses this organization will not send to. Hard bounces and complaints are added automatically.
      tags:
      - Suppressions
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 50
      - name: cursor
        in: query
        schema:
          type: string
          format: uuid
      - name: reason
        in: query
        schema:
          type: string
          enum:
          - bounce
          - complaint
          - manual
      - name: email
        in: query
        description: Substring match. Pass a domain (`@acme.com`) to see every suppressed address there.
        schema:
          type: string
          maxLength: 320
      responses:
        '200':
          description: A page of entries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSuppressionsResponse'
        '400':
          description: The request body or query failed validation (`VALIDATION_ERROR`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed, or revoked API key (`UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key exists but may not reach this resource — a `sending_access` key outside the send paths, a test-mode key writing live state, or an account on hold (`FORBIDDEN`, `ACCOUNT_RESTRICTED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (`RATE_LIMITED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error (`INTERNAL_ERROR`). Carries `request_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      operationId: createSuppression
      summary: Suppress an address
      description: Adding an address that is already suppressed returns the existing entry unchanged — a manual add never rewrites a real bounce or complaint. Refused for test-mode keys.
      tags:
      - Suppressions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSuppressionRequest'
      responses:
        '200':
          description: Already suppressed; the entry in force is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Suppression'
        '201':
          description: Suppressed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Suppression'
        '400':
          description: The request body or query failed validation (`VALIDATION_ERROR`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed, or revoked API key (`UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The suppression list is full for this plan, or the key is test-mode (`PLAN_LIMIT_EXCEEDED`, `FORBIDDEN`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: The address was modified concurrently; retry (`CONFLICT`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (`RATE_LIMITED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error (`INTERNAL_ERROR`). Carries `request_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /suppressions/batch:
    post:
      operationId: importSuppressions
      summary: Import up to 1,000 suppressed addresses
      description: For carrying a suppression list over from another provider before the first send.
      tags:
      - Suppressions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportSuppressionsRequest'
      responses:
        '201':
          description: Imported.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportSuppressionsResponse'
        '400':
          description: The request body or query failed validation (`VALIDATION_ERROR`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed, or revoked API key (`UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The import would exceed the plan suppression cap, or the key is test-mode.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (`RATE_LIMITED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error (`INTERNAL_ERROR`). Carries `request_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /suppressions/export:
    get:
      operationId: exportSuppressions
      summary: Download the suppression list as CSV
      description: Streams the whole list as `email,reason,created_at`, sorted by address.
      tags:
      - Suppressions
      responses:
        '200':
          description: The CSV file.
          content:
            text/csv:
              schema:
                type: string
        '401':
          description: Missing, malformed, or revoked API key (`UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key exists but may not reach this resource — a `sending_access` key outside the send paths, a test-mode key writing live state, or an account on hold (`FORBIDDEN`, `ACCOUNT_RESTRICTED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (`RATE_LIMITED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error (`INTERNAL_ERROR`). Carries `request_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /suppressions/{id}:
    delete:
      operationId: deleteSuppression
      summary: Un-suppress an address
      description: Accepts the entry id or the address itself (URL-encoded). Removing bounced or complained addresses in bulk is what damages sender reputation — do it when the address was fixed, not to retry a failing list.
      tags:
      - Suppressions
      parameters:
      - name: id
        in: path
        required: true
        description: The entry id, or the suppressed email address.
        schema:
          type: string
      responses:
        '200':
          description: Removed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedCountResponse'
        '401':
          description: Missing, malformed, or revoked API key (`UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Test-mode keys cannot modify the suppression list (`FORBIDDEN`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource on this organization (`NOT_FOUND`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (`RATE_LIMITED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Unexpected server error (`INTERNAL_ERROR`). Carries `request_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Suppression:
      type: object
      required:
      - id
      - email
      - reason
      - created_at
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        reason:
          type: string
          enum:
          - bounce
          - complaint
          - manual
        created_at:
          type: string
          format: date-time
    ImportSuppressionsRequest:
      type: object
      required:
      - emails
      additionalProperties: false
      properties:
        emails:
          type: array
          minItems: 1
          maxItems: 1000
          description: Bare addresses, objects, or a mix — so a CSV column can be posted unreshaped.
          items:
            oneOf:
            - type: string
              format: email
              maxLength: 320
            - type: object
              required:
              - email
              additionalProperties: false
              properties:
                email:
                  type: string
                  format: email
                  maxLength: 320
                reason:
                  type: string
                  enum:
                  - bounce
                  - complaint
                  - manual
                  default: manual
    Error:
      type: object
      description: Every non-2xx response from the API has this shape. `code` is stable and safe to branch on; `error` is a human sentence that may change.
      required:
      - error
      - code
      properties:
        error:
          type: string
          description: Human-readable explanation of the failure.
        code:
          type: string
          enum:
          - UNAUTHORIZED
          - FORBIDDEN
          - NOT_FOUND
          - VALIDATION_ERROR
          - RATE_LIMITED
          - MONTHLY_LIMIT_EXCEEDED
          - DAILY_LIMIT_EXCEEDED
          - PLAN_LIMIT_EXCEEDED
          - ALL_SUPPRESSED
          - RECIPIENT_DOMAIN_UNDELIVERABLE
          - DOMAIN_NOT_VERIFIED
          - SENDING_SUSPENDED
          - ACCOUNT_RESTRICTED
          - WORKSPACE_INACTIVE
          - SENDER_NOT_PERMITTED
          - SERVICE_PAUSED
          - LIST_SEND_HELD
          - BROADCAST_HELD
          - ATTACHMENT_STORAGE_ERROR
          - INTERNAL_ERROR
          - CONFLICT
          - BAD_REQUEST
          - PAYLOAD_TOO_LARGE
          description: Stable machine-readable error code.
        request_id:
          type: string
          description: Correlation id, returned on 500s and echoed in the `X-Request-Id` header on every response. Quote it in support requests.
    CreateSuppressionRequest:
      type: object
      required:
      - email
      additionalProperties: false
      properties:
        email:
          type: string
          format: email
          maxLength: 320
        reason:
          type: string
          enum:
          - bounce
          - complaint
          - manual
          default: manual
          description: An add never overwrites the reason an address is already suppressed for.
    DeletedCountResponse:
      type: object
      required:
      - deleted
      properties:
        deleted:
          type: integer
          description: May be lower than what was asked for — an id may already be gone. Retries settle at 0 rather than failing.
    ImportSuppressionsResponse:
      type: object
      required:
      - count
      - already_suppressed
      - duplicates
      properties:
        count:
          type: integer
          description: Entries written.
        already_suppressed:
          type: integer
          description: Entries already on the list.
        duplicates:
          type: integer
          description: Repeated addresses in the payload.
    ListSuppressionsResponse:
      type: object
      required:
      - data
      - next_cursor
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Suppression'
        next_cursor:
          type:
          - string
          - 'null'
          format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An eusend API key, sent as `Authorization: Bearer eu_live_…`. Create one in the dashboard under API keys.'
externalDocs:
  description: eusend documentation
  url: https://eusend.dev/docs