ReachabilityUpdate
ODP Node SDK / ODP / ReachabilityUpdate
Interface: ReachabilityUpdate
Defined in: src/Api/Types/Reachability.ts:23
The payload for an ODP messaging identifier reachability update via v3 APIs.
See V3 Reachability API
Properties
event_data?
optional
event_data:EventData
Defined in: src/Api/Types/Reachability.ts:54
Additional event fields/values that should be included if an ODP event is generated as a result of this update
identifier_field_name
identifier_field_name:
string
Defined in: src/Api/Types/Reachability.ts:27
The name of the messaging identifier field you want to update, e.g., email
identifier_value
identifier_value:
string
Defined in: src/Api/Types/Reachability.ts:31
A valid messaging identifier value, such as an email address for the email identifier
reachable
reachable:
boolean
Defined in: src/Api/Types/Reachability.ts:35
true indicates the identifier value is now reachable, false indicates it is no longer reachable
reachable_update_reason?
optional
reachable_update_reason:string
Defined in: src/Api/Types/Reachability.ts:45
A specific error code or note for the change type. Should be human readable.
reachable_update_ts?
optional
reachable_update_ts:string
|number
|Date
Defined in: src/Api/Types/Reachability.ts:50
The time of the event if this is a historical change (defaults to current time).
Must be formated in ISO8601, provided as a Date object, or as a unix epoch.
reachable_update_type?
optional
reachable_update_type:ReachabilityUpdateType
Defined in: src/Api/Types/Reachability.ts:41
The type of change to the reachability status.
If reachable is set to true, this field must be left null.
If reachable is false, this field is required.
Updated 4 days ago