Connect / Client / update_contact

update_contact#

Connect.Client.update_contact(**kwargs)#

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

Warning

You can add or update user-defined contact information for both ongoing and completed contacts.

See also: AWS API Documentation

Request Syntax

response = client.update_contact(
    InstanceId='string',
    ContactId='string',
    Name='string',
    Description='string',
    References={
        'string': {
            'Value': 'string',
            'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
        }
    }
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

  • Name (string) – The name of the contact.

  • Description (string) – The description of the contact.

  • References (dict) –

    Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

    • (string) –

      • (dict) –

        Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

        • Value (string) – [REQUIRED]

          A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

        • Type (string) – [REQUIRED]

          The type of the reference. DATE must be of type Epoch timestamp.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ThrottlingException