---
title: "Check if an email is in the suppression list"
url: "https://nov18-dev.movespot.fyi/apis/internal-mailbox-0/versions/2eb01e46-804a-4f02-b351-ad840700d243/operations/checkEmailSuppressionState"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-mailbox-0/versions/2eb01e46-804a-4f02-b351-ad840700d243.md

# Check if an email is in the suppression list

`POST` `/internal/email/suppression-list/check`

Operation ID: `checkEmailSuppressionState`

Check if an email is in the suppression list. Note: The email address is not a part of the URL path so as to avoid any PII data in the access logs.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Response of email suppression check request

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal Mailbox
  version: 0.0.1
servers:
  - url: http://mailbox-api.mailbox.svc.cluster.local:5600/v1
    description: Mailbox API server
paths:
  /internal/email/suppression-list/check:
    post:
      operationId: checkEmailSuppressionState
      summary: Check if an email is in the suppression list
      description: |
        Check if an email is in the suppression list.

        Note: The email address is not a part of the URL path so
        as to avoid any PII data in the access logs.
      requestBody:
        $ref: "#/components/requestBodies/EmailSuppressionState"
      responses:
        "200":
          $ref: "#/components/responses/EmailSuppressionStateResponse"
      tags:
        - Email
        - Suppression List
components:
  requestBodies:
    EmailSuppressionState:
      description: Body of suppression check request
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/EmailQuery"
  responses:
    EmailSuppressionStateResponse:
      description: Response of email suppression check request
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/EmailSuppressionStateResponsePayload"
  schemas:
    EmailQuery:
      type: object
      properties:
        email:
          description: The email address to check against the suppression list.
          type: string
          format: email
          example: user@example.com
      required:
        - email
    EmailSuppressionStateResponsePayload:
      type: object
      properties:
        email:
          description: The email address to check against the suppression list.
          type: string
          format: email
          example: user@example.com
        is_suppressed:
          description: True if the email is in the suppression list, false otherwise.
          type: boolean
          example: true
        identifiers:
          description: Kong Identifiers which are associated with this suppressed email
            entry.
          type: array
          items:
            $ref: "#/components/schemas/Identifier"
      required:
        - email
        - is_suppressed
    Identifier:
      type: object
      properties:
        principal_type:
          description: Type of the principal
          type: string
          example: user
        org_id:
          description: ID of the Organization which the principal belongs to.
          type: string
          example: bc7e7998-b46b-4b3b-adbe-a4f761c408f3
        principal_id:
          description: Identifier of the associated principal
          type: string
          format: uuid
          example: 5a568c6a-8121-4800-86dc-aac15ce3970e
```
