IdentifierDefinition

8 min

ODP Node SDK

ODP Node SDK / ODP / IdentifierDefinition

Interface: IdentifierDefinition

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

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

Properties

display_name

display_name: string

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

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

merge_confidence

merge_confidence: "low" | "high"

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

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".

messaging?

optional messaging: boolean

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

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

name

name: string

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

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