Connect / Client / start_outbound_email_contact

start_outbound_email_contact#

Connect.Client.start_outbound_email_contact(**kwargs)#

See also: AWS API Documentation

Request Syntax

response = client.start_outbound_email_contact(
    InstanceId='string',
    ContactId='string',
    FromEmailAddress={
        'EmailAddress': 'string',
        'DisplayName': 'string'
    },
    DestinationEmailAddress={
        'EmailAddress': 'string',
        'DisplayName': 'string'
    },
    AdditionalRecipients={
        'CcEmailAddresses': [
            {
                'EmailAddress': 'string',
                'DisplayName': 'string'
            },
        ]
    },
    EmailMessage={
        'MessageSourceType': 'TEMPLATE'|'RAW',
        'TemplatedMessageConfig': {
            'KnowledgeBaseId': 'string',
            'MessageTemplateId': 'string',
            'TemplateAttributes': {
                'CustomAttributes': {
                    'string': 'string'
                },
                'CustomerProfileAttributes': 'string'
            }
        },
        'RawMessage': {
            'Subject': 'string',
            'Body': 'string',
            'ContentType': 'string'
        }
    },
    ClientToken='string'
)
Parameters:

  • InstanceId (string) – [REQUIRED]

  • ContactId (string) – [REQUIRED]

  • FromEmailAddress (dict) –

    • EmailAddress (string) – [REQUIRED]

    • DisplayName (string) –

  • DestinationEmailAddress (dict) –

    [REQUIRED]

    • EmailAddress (string) – [REQUIRED]

    • DisplayName (string) –

  • AdditionalRecipients (dict) –

    • CcEmailAddresses (list) –

      • (dict) –

        • EmailAddress (string) – [REQUIRED]

        • DisplayName (string) –

  • EmailMessage (dict) –

    [REQUIRED]

    • MessageSourceType (string) – [REQUIRED]

    • TemplatedMessageConfig (dict) –

      • KnowledgeBaseId (string) – [REQUIRED]

      • MessageTemplateId (string) – [REQUIRED]

      • TemplateAttributes (dict) – [REQUIRED]

        • CustomAttributes (dict) –

          • (string) –

            • (string) –

        • CustomerProfileAttributes (string) –

    • RawMessage (dict) –

      • Subject (string) – [REQUIRED]

      • Body (string) – [REQUIRED]

      • ContentType (string) – [REQUIRED]

  • ClientToken (string) – This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

  • (dict) –

    • ContactId (string) –

Exceptions