Microsoft Azure Communication Services Opt Outs Add API

openapi: 3.2.0
info:
  title: Azure Communication SMS Service Opt Outs Add API
  description: Azure Communication SMS Service
  version: '2026-01-23'
tags:
- name: OptOutsAdd
paths:
  /sms/optouts:add:
    post:
      tags:
      - OptOutsAdd
      summary: Add phone numbers to the optouts list which shall stop receiving messages from…
      operationId: OptOuts_Add
      parameters:
      - name: api-version
        in: query
        description: Version of API to invoke.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptOutResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptOutRequest'
        required: true
components:
  schemas:
    OptOutResponse:
      description: Response for an opt out request. Validate the returned items in the response to see which recipients were successfully added or removed from the opt outs list.
      required:
      - value
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/OptOutResponseItem'
    ErrorDetail:
      description: Error detail information.
      required:
      - code
      - message
      type: object
      properties:
        code:
          description: The error code.
          type: string
        message:
          description: The error message.
          type: string
        innerError:
          description: Additional error details.
          type: object
    OptOutResponseItem:
      required:
      - httpStatusCode
      - to
      type: object
      properties:
        to:
          description: The recipient phone number (in E.164 format).
          minLength: 1
          type: string
        httpStatusCode:
          format: int32
          type: integer
        isOptedOut:
          description: Optional flag specifying if number was Opted Out from receiving messages
          type: boolean
        errorMessage:
          description: Optional error message in case of 4xx/5xx errors.
          type: string
    StandardErrorResponse:
      description: Standard error response format.
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
    OptOutRecipient:
      description: A single opt out recipient number.
      required:
      - to
      type: object
      properties:
        to:
          description: The recipient's phone number (in E.164 format).
          minLength: 1
          type: string
    OptOutRequest:
      description: An opt out request.
      required:
      - from
      - recipients
      type: object
      properties:
        from:
          description: The sender's identifier (typically phone number in E.164 format) that is owned by the authenticated account.
          minLength: 1
          type: string
        recipients:
          maxItems: 100
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/OptOutRecipient'
    BadRequestErrorResponse:
      description: Bad Request error response that can represent both validation errors and standard API errors.
      type: object
      properties:
        type:
          description: A URI reference that identifies the problem type (for validation errors).
          type: string
        title:
          description: A short, human-readable summary of the problem type (for validation errors).
          type: string
        status:
          description: The HTTP status code (for validation errors).
          type: integer
          format: int32
        errors:
          description: Dictionary of field-specific validation errors (for validation errors).
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        traceId:
          description: The trace identifier for the request (for validation errors).
          type: string
        error:
          description: Error detail information (for standard API errors).
          $ref: '#/components/schemas/ErrorDetail'
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    description: The communication resource, for example https://my-resource.communication.azure.com
    required: true
    type: string
    in: path
    x-ms-skip-url-encoding: true
    x-ms-parameter-location: client
    format: url