Skip to content

Start Outbound Email Contact

connect_start_outbound_email_contact R Documentation

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer

Description

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.

Usage

connect_start_outbound_email_contact(InstanceId, ContactId,
  FromEmailAddress, DestinationEmailAddress, AdditionalRecipients,
  EmailMessage, ClientToken)

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.
ContactId

[required] The identifier of the contact in this instance of Connect Customer.
FromEmailAddress

The email address associated with the Connect Customer instance.
DestinationEmailAddress

[required] The email address of the customer.
AdditionalRecipients

The additional recipients address of email in CC.
EmailMessage

[required] The email message body to be sent to the newly created email.
ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Value

A list with the following syntax:

list(
  ContactId = "string"
)

Request syntax

svc$start_outbound_email_contact(
  InstanceId = "string",
  ContactId = "string",
  FromEmailAddress = list(
    EmailAddress = "string",
    DisplayName = "string"
  ),
  DestinationEmailAddress = list(
    EmailAddress = "string",
    DisplayName = "string"
  ),
  AdditionalRecipients = list(
    CcEmailAddresses = list(
      list(
        EmailAddress = "string",
        DisplayName = "string"
      )
    )
  ),
  EmailMessage = list(
    MessageSourceType = "TEMPLATE"|"RAW",
    TemplatedMessageConfig = list(
      KnowledgeBaseId = "string",
      MessageTemplateId = "string",
      TemplateAttributes = list(
        CustomAttributes = list(
          "string"
        ),
        CustomerProfileAttributes = "string"
      )
    ),
    RawMessage = list(
      Subject = "string",
      Body = "string",
      ContentType = "string"
    )
  ),
  ClientToken = "string"
)