Request Syntax Request Parameters Response Elements Errors See Also

UpdateContact

Updates the contact details by the contact ARN.

Request Syntax


{
   "ContactArn": "string",
   "DisplayName": "string",
   "FirstName": "string",
   "LastName": "string",
   "PhoneNumber": "string",
   "PhoneNumbers": [ 
      { 
         "Number": "string",
         "Type": "string"
      }
   ],
   "SipAddresses": [ 
      { 
         "Type": "string",
         "Uri": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ContactArn

The ARN of the contact to update.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

DisplayName

The updated display name of the contact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: No

FirstName

The updated first name of the contact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: No

LastName

The updated last name of the contact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: No

PhoneNumber

The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: ^[\+0-9\#\,$][\+0-9\-\.\/\($\,\#\s]+$

Required: No

PhoneNumbers

The list of phone numbers for the contact.

Type: Array of PhoneNumber objects

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Required: No

SipAddresses

The list of SIP addresses for the contact.

Type: Array of SipAddress objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No

Response Elements

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

Errors

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

ConcurrentModificationException

There is a concurrent modification of resources.

HTTP Status Code: 400

NotFoundException

The resource is not found.

HTTP Status Code: 400