Reachability

post
Update Reachability

https://api.zaius.com/v3/reachability
This endpoint allows you to update reachability for a messaging identifier. 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.
Request
Response
Request
Body Parameters
identifier_value
required
string
a valid messaging identifier, such as an email address
identifier_field_name
required
string
the name of the field that this identifier falls under, such as email
reachable
required
boolean
true/false indicator of the reachability status for this identifier value
reachable_update_type
required
string
the type of change to reachability status; if reachable is set to true, this field must be left null. Reason must fall into the follow options: - hard_bounce - soft_bounce - spam_report - uninstall - invalid_identifier - returned_to_sender - unknown - expired - other
reachable_update_reason
optional
string
a specific error code or note for the change type
reachable_update_ts
optional
string
the time of the event (defaults to current time)
event_data
optional
object
object of key/value pairs, which are added to the generated events
Response
200: OK
{
"title": "Accepted",
"status": 202,
"timestamp": "2019-07-30T23:55:00.519Z"
}
400: Bad Request
{
"title": "Bad Request",
"status": 400,
"timestamp": "2019-07-30T23:53:48.615Z",
"detail": {
"message": "Unable to parse request body."
}
}
Example Payload
[{
"identifier_value": "email@zaius.com",
"identifier_field_name": "email",
"reachable": false,
"reachable_update_type": "hard_bounce"
},{
"identifier_value": "email2@zaius.com",
"identifier_field_name": "email",
"reachable": true
}]

get
Get Reachability

https://api.zaius.com/v3/reachability/{identifier_field_name}?id={identifier_value}
This endpoint allows you to get reachability information about an identifier.
Request
Response
Request
Path Parameters
identifier_field_name
required
string
the name of the field that this identifiers falls under, such as email
Query Parameters
id
required
string
a valid messaging identifier, such as an email address
Response
200: OK
{
"identifier_field_name": "email",
"identifier_value": "test@zaius.com",
"reachable_update_type": "hard_bounce",
"reachable_update_reason": "5xx from mailbox provider",
"reachable_update_ts": 1572721108,
"reachable": false,
"zaius_id": 3355837520960159745
}
Example Request
curl -iX GET \
'https://api.zaius.com/v3/reachability/email?id=email@zaius.com' \
-H 'x-api-key: example.apiKey'