IdentifierMetadata
6 min
ODP Node SDK / ODP / IdentifierMetadata
Interface: IdentifierMetadata
Defined in: src/Api/Types/Identifiers.ts:24
Custom metadata that can be added to any identifier. Do not include fields you do not want to update.
Properties
identifier_field_name
identifier_field_name: string
Defined in: src/Api/Types/Identifiers.ts:28
The name of the identifier field you want to update, e.g., email
identifier_value
identifier_value: string
Defined in: src/Api/Types/Identifiers.ts:32
An existing identifier value, such as a known email address
metadata
metadata: object
Defined in: src/Api/Types/Identifiers.ts:36
The metadata to update
Index Signature
[field: string]: null | string | number | boolean
The fields must already exist before updating. The value should be a string, number, or boolean value matching the metadata field type. An explicitly null value will remove the previous value.