ODP Node SDK / ODP / IdentifierDefinition

IdentifierDefinition

The ODP Identifier definition payload for schema API.
See V3 Schema API
for details.

Index

Properties

display_name

string

The human-readable name, ending with title-case version of the name suffix: " ID", " Hash", " Number", " Token",
" Alias", " Address", or " Key".

Defined in: src/Api/Types/Schema.ts:130

merge_confidence

"low" | "high"

The level of confidence that this identifier can be used to merge customer profiles together. If the identifier
is likely to be shared between individuals (eg, a shared device token), this value should be set to "low". If it
is very deterministic (eg, a personal account ID), this value should be set to "high".

Defined in: src/Api/Types/Schema.ts:136

messaging?

boolean

Whether this identifier can be used to message customers within campaigns.

Defined in: src/Api/Types/Schema.ts:140

name

string

The field name of the identifier, ending with one of the known suffixes: "_id", "_hash", "_number", "_token",
"_alias", "_address", or "_key".

Defined in: src/Api/Types/Schema.ts:125