social.tophhie.profile

tophhie.cloud

Documentation

main record

No description available.

Record Key literal:self Fixed literal value

Properties

createdAt string datetime Required

ISO 8601 timestamp when this profile record was created.

pdsPreferences ref #pdsPreferences Required

User's opt-in/out preferences for PDS features.

updatedAt string datetime Optional

ISO 8601 timestamp when this profile record was updated.

View raw schema 
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "createdAt",
      "pdsPreferences",
      "communicationPreferences"
    ],
    "properties": {
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "ISO 8601 timestamp when this profile record was created."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "ISO 8601 timestamp when this profile record was updated."
      },
      "pdsPreferences": {
        "ref": "#pdsPreferences",
        "type": "ref",
        "description": "User's opt-in/out preferences for PDS features."
      },
      "communicationPreferences": {
        "ref": "#communicationPreferences",
        "type": "ref",
        "description": "User's opt-in/out preferences for communications."
      }
    },
    "description": "Tophhie profile record"
  }
}
communicationPreferences object

Granular communication consent flags.

Properties

marketing boolean Required

True if the user consents to receive marketing communications.

View raw schema 
{
  "type": "object",
  "required": [
    "marketing"
  ],
  "properties": {
    "marketing": {
      "type": "boolean",
      "description": "True if the user consents to receive marketing communications."
    }
  },
  "description": "Granular communication consent flags."
}
pdsPreferences object

Granular PDS preference consent flags.

Properties

accessibilityScoring boolean Required

True if the user participates in accessibility scoring.

showOnHomepage boolean Required

True if the user is shown on the Tophhie Social homepage.

View raw schema 
{
  "type": "object",
  "required": [
    "showOnHomepage",
    "accessibilityScoring"
  ],
  "properties": {
    "showOnHomepage": {
      "type": "boolean",
      "description": "True if the user is shown on the Tophhie Social homepage."
    },
    "accessibilityScoring": {
      "type": "boolean",
      "description": "True if the user participates in accessibility scoring."
    }
  },
  "description": "Granular PDS preference consent flags."
}

Lexicon Garden

@