Amazon Pinpoint · JSON Structure

Amazon Pinpoint Endpoint User Structure

Specifies data for one or more attributes that describe the user who's associated with an endpoint.

Type: object Properties: 2
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

EndpointUser is a JSON Structure definition published by Amazon Pinpoint, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserAttributes UserId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-endpoint-user-structure.json",
  "name": "EndpointUser",
  "description": "Specifies data for one or more attributes that describe the user who's associated with an endpoint.",
  "type": "object",
  "properties": {
    "UserAttributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfListOf__string"
        },
        {
          "description": "<p>One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.</p> <p>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.</p>"
        }
      ]
    },
    "UserId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the user."
        }
      ]
    }
  }
}