Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Update reachability

Update reachability for a messaging identifier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Note

When importing reachability events to Optimizely Data Platform (ODP), you must use the customer's messaging identifier for which you want to update the reachability status. For example, if you want to update the reachability status for an email, you must use that email as the identifier in your reachability event. For more information about identifiers in ODP, see our developer documentation.

Reachability may impact attempts to send marketing campaigns to the identifier. If noted as unreachable, certain marketing services or channels may skip the identifier, even when qualified for the campaign. This endpoint generates events of type reachability and action reachable or unreachable.

Body Params
string
required

A valid messaging identifier, like an email address.

string
required

The name of the field that this identifier falls under (for example, email).

boolean
required
Defaults to true

True/false indicator of the reachability status for this identifier value.

string
required

The type of change to the reachability status. If reachable is set to true, you must leave this field null. Reason must be one of the following options: hard_bounce, soft_bounce, spam_report, uninstall, invalid_identifier, returned_to_sender, unknown, expired, other.

string

A specific error code or note for the change type.

string

The time of the event (defaults to current time).

integer
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json