OptOutResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-communication-services/json-schema/microsoft-azure-communication-services-opt-out-response-schema.json",
  "title": "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.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-communication-services-sms-api-openapi.yml#/components/schemas/OptOutResponse",
  "required": [
    "value"
  ],
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OptOutResponseItem"
      }
    }
  },
  "$defs": {
    "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"
        }
      }
    }
  }
}