| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Connect.UpdateContactAttributes
Description
Creates or updates user-defined contact attributes associated with the specified contact.
You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.
Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about CTR retention and the maximum size of the CTR attributes section, see Feature specifications in the Amazon Connect Administrator Guide.
Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, which was September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
Synopsis
- data UpdateContactAttributes = UpdateContactAttributes' {}
- newUpdateContactAttributes :: Text -> Text -> UpdateContactAttributes
- updateContactAttributes_initialContactId :: Lens' UpdateContactAttributes Text
- updateContactAttributes_instanceId :: Lens' UpdateContactAttributes Text
- updateContactAttributes_attributes :: Lens' UpdateContactAttributes (HashMap Text Text)
- data UpdateContactAttributesResponse = UpdateContactAttributesResponse' {
- httpStatus :: Int
- newUpdateContactAttributesResponse :: Int -> UpdateContactAttributesResponse
- updateContactAttributesResponse_httpStatus :: Lens' UpdateContactAttributesResponse Int
Creating a Request
data UpdateContactAttributes Source #
See: newUpdateContactAttributes smart constructor.
Constructors
| UpdateContactAttributes' | |
Fields
| |
Instances
newUpdateContactAttributes Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateContactAttributes |
Create a value of UpdateContactAttributes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:initialContactId:UpdateContactAttributes', updateContactAttributes_initialContactId - The identifier of the contact. This is the identifier of the contact
associated with the first interaction with the contact center.
$sel:instanceId:UpdateContactAttributes', updateContactAttributes_instanceId - The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
$sel:attributes:UpdateContactAttributes', updateContactAttributes_attributes - The Amazon Connect attributes. These attributes can be accessed in
contact flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
Request Lenses
updateContactAttributes_initialContactId :: Lens' UpdateContactAttributes Text Source #
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
updateContactAttributes_instanceId :: Lens' UpdateContactAttributes Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
updateContactAttributes_attributes :: Lens' UpdateContactAttributes (HashMap Text Text) Source #
The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
Destructuring the Response
data UpdateContactAttributesResponse Source #
See: newUpdateContactAttributesResponse smart constructor.
Constructors
| UpdateContactAttributesResponse' | |
Fields
| |
Instances
newUpdateContactAttributesResponse Source #
Create a value of UpdateContactAttributesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateContactAttributesResponse', updateContactAttributesResponse_httpStatus - The response's http status code.
Response Lenses
updateContactAttributesResponse_httpStatus :: Lens' UpdateContactAttributesResponse Int Source #
The response's http status code.