Alexa For Business
Alexa for Business API (API Version 2017-11-09)

CreateContact

Creates a contact with the specified details.

Request Syntax

{ "ClientRequestToken": "string", "DisplayName": "string", "FirstName": "string", "LastName": "string", "PhoneNumber": "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.

ClientRequestToken

A unique, user-specified identifier for this request that ensures idempotency.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 150.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

DisplayName

The name of the contact to display on the console.

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 first name of the contact that is used to call the contact on the device.

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: Yes

LastName

The last name of the contact that is used to call the contact on the device.

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 phone number of the contact in E.164 format.

Type: String

Pattern: ^\+\d{8,}$

Required: Yes

Response Syntax

{ "ContactArn": "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.

ContactArn

The ARN of the newly created address book.

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}

Errors

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

AlreadyExistsException

The resource being created already exists. HTTP Status Code: 400

HTTP Status Code: 400

LimitExceededException

You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: