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",
  "record": {
    "description": "Tophhie profile record",
    "properties": {
      "communicationPreferences": {
        "description": "User's opt-in/out preferences for communications.",
        "ref": "#communicationPreferences",
        "type": "ref"
      },
      "createdAt": {
        "description": "ISO 8601 timestamp when this profile record was created.",
        "format": "datetime",
        "type": "string"
      },
      "pdsPreferences": {
        "description": "User's opt-in/out preferences for PDS features.",
        "ref": "#pdsPreferences",
        "type": "ref"
      },
      "updatedAt": {
        "description": "ISO 8601 timestamp when this profile record was updated.",
        "format": "datetime",
        "type": "string"
      }
    },
    "required": [
      "createdAt",
      "pdsPreferences",
      "communicationPreferences"
    ],
    "type": "object"
  },
  "type": "record"
}
communicationPreferences object

Granular communication consent flags.

Properties

marketing boolean Required

True if the user consents to receive marketing communications.

View raw schema 
{
  "description": "Granular communication consent flags.",
  "properties": {
    "marketing": {
      "description": "True if the user consents to receive marketing communications.",
      "type": "boolean"
    }
  },
  "required": [
    "marketing"
  ],
  "type": "object"
}
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 
{
  "description": "Granular PDS preference consent flags.",
  "properties": {
    "accessibilityScoring": {
      "description": "True if the user participates in accessibility scoring.",
      "type": "boolean"
    },
    "showOnHomepage": {
      "description": "True if the user is shown on the Tophhie Social homepage.",
      "type": "boolean"
    }
  },
  "required": [
    "showOnHomepage",
    "accessibilityScoring"
  ],
  "type": "object"
}

Lexicon Garden

@