ODP Node SDK

---

ODP Node SDK / ODP / GetReachabilityResponse

Interface: GetReachabilityResponse

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

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

Properties

identifier_field_name

identifier_field_name: string

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

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

---

identifier_value

identifier_value: string

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

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

---

reachable

reachable: boolean

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

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

---

reachable_update_reason

reachable_update_reason: null | string

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

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

---

reachable_update_ts

reachable_update_ts: null | number

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

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

---

reachable_update_type

reachable_update_type: ReachabilityUpdateType

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

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