---
title: ReachabilityUpdate
slug: data-platform/connect-platform/node-sdk-api-reference-zaius-interfaces-reachabilityupdate
docTags: 
createdAt: 2026-08-05T20:06:38.960Z
---

[ODP Node SDK](docId\:gxEU_0AA37IEZJK-uoVcT) / [Zaius](docId\:Ymt8R5EsKRYBHwqG3pJkL) / ReachabilityUpdate

# ReachabilityUpdate

The payload for a Zaius messaging identifier reachability update via v3 APIs.
See [V3 Reachability API](docId\:Hs5905raSe2K7UqefNuDR)

## Index

### Properties

- [event\\\_data](docId\:mRtfwl6FZBDQP95D5Wkca)
- [identifier\\\_field\\\_name](docId\:mRtfwl6FZBDQP95D5Wkca)
- [identifier\\\_value](docId\:mRtfwl6FZBDQP95D5Wkca)
- [reachable](docId\:mRtfwl6FZBDQP95D5Wkca)
- [reachable\\\_update\\\_reason](docId\:mRtfwl6FZBDQP95D5Wkca)
- [reachable\\\_update\\\_ts](docId\:mRtfwl6FZBDQP95D5Wkca)
- [reachable\\\_update\\\_type](docId\:mRtfwl6FZBDQP95D5Wkca)

## Properties

### event\_data?

:::hint{type="info"}
[`` `EventData` ``](docId:13hn0PEBcKDfahoBPgLYp)
:::

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](https://github.com/ZaiusInc/node-sdk/blob/46602d2/src/Api/Types/Reachability.ts#L54)

### identifier\_field\_name

:::BlockQuote
`string`
:::

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

Defined in: [src/Api/Types/Reachability.ts:27](https://github.com/ZaiusInc/node-sdk/blob/46602d2/src/Api/Types/Reachability.ts#L27)

### identifier\_value

:::BlockQuote
`string`
:::

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

Defined in: [src/Api/Types/Reachability.ts:31](https://github.com/ZaiusInc/node-sdk/blob/46602d2/src/Api/Types/Reachability.ts#L31)

### reachable

:::BlockQuote
`boolean`
:::

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

Defined in: [src/Api/Types/Reachability.ts:35](https://github.com/ZaiusInc/node-sdk/blob/46602d2/src/Api/Types/Reachability.ts#L35)

### reachable\_update\_reason?

:::BlockQuote
`string`
:::

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

Defined in: [src/Api/Types/Reachability.ts:45](https://github.com/ZaiusInc/node-sdk/blob/46602d2/src/Api/Types/Reachability.ts#L45)

### reachable\_update\_ts?

:::BlockQuote
`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](https://github.com/ZaiusInc/node-sdk/blob/46602d2/src/Api/Types/Reachability.ts#L50)

### reachable\_update\_type?

:::hint{type="info"}
[`` `ReachabilityUpdateType` ``](docId:13hn0PEBcKDfahoBPgLYp)
:::

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](https://github.com/ZaiusInc/node-sdk/blob/46602d2/src/Api/Types/Reachability.ts#L41)