Microsoft Azure Communication Services Suppression Lists API

openapi: 3.2.0
info:
  title: Azure Communication Services Management Suppression Lists…
  version: '2026-03-18'
  description: REST API for Email Services/Domains/SuppressionLists
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: SuppressionLists
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists
  : get:
      operationId: SuppressionLists_ListByDomain
      tags:
      - SuppressionLists
      summary: List
      description: List all suppression lists for a domains resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListResourceCollection'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}
  : get:
      operationId: SuppressionLists_Get
      tags:
      - SuppressionLists
      summary: Get
      description: Get a SuppressionList resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      - name: suppressionListName
        in: path
        description: The name of the suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: SuppressionLists_CreateOrUpdate
      tags:
      - SuppressionLists
      summary: Create Or Update
      description: Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      - name: suppressionListName
        in: path
        description: The name of the suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Resource 'SuppressionListResource' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListResource'
        '201':
          description: Resource 'SuppressionListResource' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuppressionListResource'
        description: Parameters for the create or update operation
        required: true
    delete:
      operationId: SuppressionLists_Delete
      tags:
      - SuppressionLists
      summary: Delete
      description: Delete a SuppressionList.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      - name: suppressionListName
        in: path
        description: The name of the suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}/suppressionListAddresses
  : get:
      operationId: SuppressionListAddresses_List
      tags:
      - SuppressionLists
      summary: Get
      description: Get all the addresses in a suppression list.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      - name: suppressionListName
        in: path
        description: The name of the suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListAddressResourceCollection'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}/suppressionListAddresses/{addressId}
  : get:
      operationId: SuppressionListAddresses_Get
      tags:
      - SuppressionLists
      summary: Get
      description: Get a SuppressionListAddress.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      - name: suppressionListName
        in: path
        description: The name of the suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: addressId
        in: path
        description: The id of the address in a suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListAddressResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: SuppressionListAddresses_CreateOrUpdate
      tags:
      - SuppressionLists
      summary: Create Or Update
      description: Create or update a SuppressionListAddress.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      - name: suppressionListName
        in: path
        description: The name of the suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: addressId
        in: path
        description: The id of the address in a suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Resource 'SuppressionListAddressResource' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListAddressResource'
        '201':
          description: Resource 'SuppressionListAddressResource' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuppressionListAddressResource'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuppressionListAddressResource'
        description: Parameters for the create or update operation
        required: true
    delete:
      operationId: SuppressionListAddresses_Delete
      tags:
      - SuppressionLists
      summary: Delete
      description: Operation to delete a single address from a suppression list.
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - name: emailServiceName
        in: path
        description: The name of the EmailService resource.
        required: true
        schema:
          type: string
          maxLength: 63
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: domainName
        in: path
        description: The name of the Domains resource.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
      - name: suppressionListName
        in: path
        description: The name of the suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      - name: addressId
        in: path
        description: The id of the address in a suppression list.
        required: true
        schema:
          type: string
          maxLength: 253
          minLength: 1
          pattern: ^[a-zA-Z0-9-]+$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SuppressionListAddressProperties:
      type: object
      description: A class that describes the properties of a SuppressionListAddress resource.
      properties:
        email:
          type: string
          description: Email address of the recipient.
        firstName:
          type: string
          description: The first name of the email recipient.
        lastName:
          type: string
          description: The last name of the email recipient.
        notes:
          type: string
          description: An optional property to provide contextual notes or a description for an address.
        lastModified:
          type: string
          format: date-time
          description: The date the address was last updated in a suppression list.
          readOnly: true
        dataLocation:
          type: string
          description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource.
          readOnly: true
      required:
      - email
    ProxyResource:
      type: object
      title: Proxy Resource
      description: The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
      allOf:
      - $ref: '#/components/schemas/Resource'
    SuppressionListAddressResourceCollection:
      type: object
      description: Collection of addresses in a suppression list. Response will include a nextLink if response contains more pages.
      properties:
        value:
          type: array
          description: The SuppressionListAddressResource items on this page
          items:
            $ref: '#/components/schemas/SuppressionListAddressResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    ErrorResponse:
      type: object
      title: Error response
      description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: The error object.
    SuppressionListProperties:
      type: object
      description: A class that describes the properties of a SuppressionList resource.
      properties:
        listName:
          type: string
          description: The name of the suppression list. This value must match one of the valid sender usernames of the sending domain.
        lastUpdatedTimeStamp:
          type: string
          description: The date the resource was last updated.
          readOnly: true
        createdTimeStamp:
          type: string
          description: The date the resource was created.
          readOnly: true
        dataLocation:
          type: string
          description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource.
          readOnly: true
    SuppressionListResource:
      type: object
      description: A class representing a SuppressionList resource.
      properties:
        properties:
          $ref: '#/components/schemas/SuppressionListProperties'
          description: The properties of a SuppressionList resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    SuppressionListAddressResource:
      type: object
      description: A object that represents a SuppressionList record.
      properties:
        properties:
          $ref: '#/components/schemas/SuppressionListAddressProperties'
          description: The properties of a SuppressionListAddress resource.
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyResource'
    SuppressionListResourceCollection:
      type: object
      description: A class representing a Domains SuppressionListResource collection.
      properties:
        value:
          type: array
          description: The SuppressionListResource items on this page
          items:
            $ref: '#/components/schemas/SuppressionListResource'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
  parameters:
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group. The name is case insensitive.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        maxLength: 90
        minLength: 1
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The ID of the target subscription. The value must be an UUID.
      required: true
      schema:
        type: string
        format: uuid
    ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      schema:
        type: string
        minLength: 1
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.