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

# Add a suppression

> 201 when created, 200 when the address was already listed. Requires `emails:send`.



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/suppressions
openapi: 3.1.0
info:
  title: Sendbaze API
  version: '1.0'
  description: >
    Transactional email and SMS for Africa. Send from your own domain through
    Amazon SES in Cape Town.

    Every send returns an id immediately; delivery is reported by webhook and in
    the dashboard logs.
  contact:
    name: Sendbaze support
    email: support@sendbaze.com
    url: https://www.sendbaze.com
servers:
  - url: https://api.sendbaze.com
security:
  - bearerAuth: []
tags:
  - name: Emails
  - name: Templates
  - name: Domains
  - name: Suppressions
  - name: Webhooks
  - name: SMS
  - name: Usage
paths:
  /v1/suppressions:
    post:
      tags:
        - Suppressions
      summary: Add a suppression
      description: >-
        201 when created, 200 when the address was already listed. Requires
        `emails:send`.
      operationId: addSuppression
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSuppressionRequest'
            example:
              email: person@example.co.za
              reason: manual
              note: Asked to be removed
      responses:
        '200':
          description: Already listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Suppression'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Suppression'
        '422':
          $ref: '#/components/responses/Unprocessable'
components:
  schemas:
    CreateSuppressionRequest:
      type: object
      required:
        - email
      properties:
        email:
          type: string
          format: email
        reason:
          type: string
          enum:
            - manual
            - unsubscribe
          default: manual
          description: manual blocks all email; unsubscribe blocks marketing only.
        note:
          type: string
          maxLength: 500
    Suppression:
      type: object
      required:
        - id
        - email
        - reason
        - messageId
        - note
        - createdAt
      properties:
        id:
          type: string
          example: sup_01j9x7k2r4m8q3v5n6b7c8d9e0
        email:
          type: string
        reason:
          type: string
          enum:
            - hard_bounce
            - complaint
            - unsubscribe
            - manual
        messageId:
          type:
            - string
            - 'null'
          description: The message whose bounce
          complaint or unsubscribe created the entry.: null
        note:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
    ErrorBody:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable error code; see the errors reference.
          example: validation_error
        message:
          type: string
        docs:
          type: string
          format: uri
        fields:
          type: object
          description: Present on validation errors. Dotted path to messages.
          additionalProperties:
            type: array
            items:
              type: string
        limit:
          type: integer
          description: On `plan_limit`, the ceiling that was reached.
        upgradeUrl:
          type: string
          format: uri
          description: >-
            Where to change plan, when a bigger plan would have allowed the
            request.
        topUpUrl:
          type: string
          format: uri
          description: >-
            Where to add wallet funds, when a balance would have allowed the
            request.
        settingsUrl:
          type: string
          format: uri
          description: >-
            Where to change an organisation setting that blocked the request
            (SMS destinations).
        domainsUrl:
          type: string
          format: uri
          description: >-
            Where to add and verify a sending domain, on
            `sandbox_recipient_not_allowed` and `sandbox_limit_reached`.
  responses:
    Unprocessable:
      description: >-
        Validation failed, a recipient is suppressed, or an SMS destination is
        not supported (destination_not_supported)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: validation_error
              message: The request has invalid fields.
              docs: https://docs.sendbaze.com/errors#validation_error
              fields:
                to.1:
                  - must be a valid email address
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates
        and returns ids without sending.

````

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