Update Predefined Attribute

connect_update_predefined_attribute

R Documentation

Updates a predefined attribute for the specified Connect Customer instance¶

Description¶

Updates a predefined attribute for the specified Connect Customer instance. A predefined attribute is made up of a name and a value.

For the predefined attributes per instance quota, see Connect Customer quotas.

Use cases

Following are common uses cases for this API:

Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents.
Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see Use contact segment attributes.

Endpoints: See Connect Customer endpoints and quotas.

Usage¶

connect_update_predefined_attribute(InstanceId, Name, Values, Purposes,
  AttributeConfiguration)

Arguments¶

InstanceId

[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Name

[required] The name of the predefined attribute.

Values

The values of the predefined attribute.

Purposes

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.

AttributeConfiguration

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website.

Value¶

An empty list.

Request syntax¶

svc$update_predefined_attribute(
  InstanceId = "string",
  Name = "string",
  Values = list(
    StringList = list(
      "string"
    )
  ),
  Purposes = list(
    "string"
  ),
  AttributeConfiguration = list(
    EnableValueValidationOnAssociation = TRUE|FALSE
  )
)