v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

High Volume SMS

Add Opt-In/Out Numbers

Adds multiple opt-outs and/or opt-ins for the specified sender number and a set of recipient numbers.

post/restapi/v1.0/account/{accountId}/a2p-sms/opt-outs/bulk-assign

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Request body

fromstring required

The phone number of a sender which the recipients should be opted out from or opted in to

optOutsstring[]

The list of phone numbers to be opted out

optInsstring[]

The list of phone numbers to be opted in

Example request

{
  "from": "+15551234455",
  "optOuts": [
    "+15551237755",
    "+15551237756"
  ],
  "optIns": [
    "+15551237799",
    "+15551237798"
  ]
}

Response

The results of adding opt-outs and opt-ins.

Example response

{
  "optIns": {
    "successful": [
      "+15551237799"
    ],
    "failed": [
      {
        "to": "+15551237798",
        "errorMessage": "Unexpected issue on removing an opt-out from bulk-assign request"
      }
    ]
  },
  "optOuts": {
    "successful": [
      "+15551237755"
    ],
    "failed": [
      {
        "to": "+15551237756",
        "errorMessage": "Unexpected issue on creating an opt-out from bulk-assign request"
      }
    ]
  }
}