Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchUpdatePhoneNumber

Updates phone number product types, calling names, or phone number names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type, the calling name, or phone name.

Note

You cannot have a duplicate phoneNumberId in a request.

Request Syntax


POST /phone-numbers?operation=batch-update HTTP/1.1
Content-type: application/json

{
   "UpdatePhoneNumberRequestItems": [ 
      { 
         "CallingName": "string",
         "Name": "string",
         "PhoneNumberId": "string",
         "ProductType": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

UpdatePhoneNumberRequestItems

Lists the phone numbers in the update request.

Type: Array of UpdatePhoneNumberRequestItem objects

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberErrors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "PhoneNumberId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

PhoneNumberErrors

A list of failed phone numbers and their error messages.

Type: Array of PhoneNumberError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401