Update Endpoint

pinpoint_update_endpoint

R Documentation

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application

Description

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.

Usage

pinpoint_update_endpoint(ApplicationId, EndpointId, EndpointRequest)

Arguments

ApplicationId

[required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

EndpointId

[required] The case insensitive unique identifier for the endpoint. The identifier can't contain $, ⁠\{⁠ or ⁠\}⁠.

EndpointRequest

[required]

Value

A list with the following syntax:

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

Request syntax

svc$update_endpoint(
  ApplicationId = "string",
  EndpointId = "string",
  EndpointRequest = list(
    Address = "string",
    Attributes = list(
      list(
        "string"
      )
    ),
    ChannelType = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP",
    Demographic = list(
      AppVersion = "string",
      Locale = "string",
      Make = "string",
      Model = "string",
      ModelVersion = "string",
      Platform = "string",
      PlatformVersion = "string",
      Timezone = "string"
    ),
    EffectiveDate = "string",
    EndpointStatus = "string",
    Location = list(
      City = "string",
      Country = "string",
      Latitude = 123.0,
      Longitude = 123.0,
      PostalCode = "string",
      Region = "string"
    ),
    Metrics = list(
      123.0
    ),
    OptOut = "string",
    RequestId = "string",
    User = list(
      UserAttributes = list(
        list(
          "string"
        )
      ),
      UserId = "string"
    )
  )
)