ReachabilityUpdate

10 min

ODP Node SDKODP Node SDK / ZaiusZaius / ReachabilityUpdate

ReachabilityUpdate

The payload for a Zaius messaging identifier reachability update via v3 APIs. See V3 Reachability APIV3 Reachability API

Index

Properties

event\_dataevent_data

identifier\_field\_nameidentifier_field_name

identifier\_valueidentifier_value

reachablereachable

reachable\_update\_reasonreachable_update_reason

reachable\_update\_tsreachable_update_ts

reachable\_update\_typereachable_update_type

Properties

event_data?

`EventData`EventData

Additional event fields/values that should be included if a Zaius event is generated as a result of this update

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

identifier_field_name

string

The name of the messaging identifier field you want to update, e.g., email

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

identifier_value

string

A valid messaging identifier value, such as an email address for the email identifier

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

reachable

boolean

true indicates the identifier value is now reachable, false indicates it is no longer reachable

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

reachable_update_reason?

string

A specific error code or note for the change type. Should be human readable.

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

reachable_update_ts?

string | number | Date

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.

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

reachable_update_type?

`ReachabilityUpdateType`ReachabilityUpdateType

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.

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