ODP Node SDK / ODP / GetReachabilityResponse

GetReachabilityResponse

The response payload for fetching the reachability details of a messaging identifier.
See V3 Reachability API

Index

Properties

• identifier_field_name
• identifier_value
• reachable
• reachable_update_reason
• reachable_update_ts
• reachable_update_type

Properties

identifier_field_name

string

The name of the messaging identifier field, e.g., email

Defined in: src/Api/Types/Reachability.ts:67

identifier_value

string

The messaging identifier value this information is relevant to, such as a customer's email address

Defined in: src/Api/Types/Reachability.ts:71

reachable

boolean

true if this specific messaging identifier is considered reachable by ODP, false otherwise

Defined in: src/Api/Types/Reachability.ts:75

reachable_update_reason

null | string

The reason for the update that last changed the reachability of this identifier

Defined in: src/Api/Types/Reachability.ts:83

reachable_update_ts

null | number

The time (unix epoch, seconds) of the last update that last changed the reachability of this identifier

Defined in: src/Api/Types/Reachability.ts:87

reachable_update_type

ReachabilityUpdateType

The type of update that last changed the reachability of this identifier

Defined in: src/Api/Types/Reachability.ts:79