Skip to content

Update in App Template

pinpoint_update_in_app_template R Documentation

Updates an existing message template for messages sent through the in-app message channel

Description

Updates an existing message template for messages sent through the in-app message channel.

Usage

pinpoint_update_in_app_template(CreateNewVersion, InAppTemplateRequest,
  TemplateName, Version)

Arguments

CreateNewVersion

Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.

If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.

InAppTemplateRequest

[required]

TemplateName

[required] The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

Version

The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.

If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.

If you don't specify a value for this parameter, Amazon Pinpoint does the following:

  • For a get operation, retrieves information about the active version of the template.

  • For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.

  • For a delete operation, deletes the template, including all versions of the template.

Value

A list with the following syntax: 

list(
  MessageBody = list(
    Message = "string",
    RequestID = "string"
  )
)

Request syntax

svc$update_in_app_template(
  CreateNewVersion = TRUE|FALSE,
  InAppTemplateRequest = list(
    Content = list(
      list(
        BackgroundColor = "string",
        BodyConfig = list(
          Alignment = "LEFT"|"CENTER"|"RIGHT",
          Body = "string",
          TextColor = "string"
        ),
        HeaderConfig = list(
          Alignment = "LEFT"|"CENTER"|"RIGHT",
          Header = "string",
          TextColor = "string"
        ),
        ImageUrl = "string",
        PrimaryBtn = list(
          Android = list(
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string"
          ),
          DefaultConfig = list(
            BackgroundColor = "string",
            BorderRadius = 123,
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string",
            Text = "string",
            TextColor = "string"
          ),
          IOS = list(
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string"
          ),
          Web = list(
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string"
          )
        ),
        SecondaryBtn = list(
          Android = list(
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string"
          ),
          DefaultConfig = list(
            BackgroundColor = "string",
            BorderRadius = 123,
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string",
            Text = "string",
            TextColor = "string"
          ),
          IOS = list(
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string"
          ),
          Web = list(
            ButtonAction = "LINK"|"DEEP_LINK"|"CLOSE",
            Link = "string"
          )
        )
      )
    ),
    CustomConfig = list(
      "string"
    ),
    Layout = "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL",
    tags = list(
      "string"
    ),
    TemplateDescription = "string"
  ),
  TemplateName = "string",
  Version = "string"
)