Update reachability

1 min

POST

https://api.us1.odp.optimizely.com/v3/reachability

Update reachability for a messaging identifier.

Body Parameters

bodyReachabilityrequired
Examples
Example Payload:
[ { "identifier_value": "[email protected]", "identifier_field_name": "email", "reachable": false, "reachable_update_type": "hard_bounce" }, { "identifier_value": "[email protected]", "identifier_field_name": "email", "reachable": true } ]
- identifier_valuestringrequired
  Description
  A valid messaging identifier, like an email address.
- identifier_field_namestringrequired
  Description
  The name of the field that this identifier falls under (for example, email).
- reachablebooleanrequired
  Description
  True/false indicator of the reachability status for this identifier value.
  Default
  true
- reachable_update_typestringrequired
  Description
  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.
- reachable_update_reasonstring
  Description
  A specific error code or note for the change type.
- reachable_update_tsstring
  Description
  The time of the event (defaults to current time).
- zaius_idinteger

Responses

202Accepted

GenericUpdateResponse

Example

{
  "title": "Accepted",
  "status": 202,
  "timestamp": "2019-07-30T23:55:00.519Z"
}

titlestring
statusinteger<int32>
Format
int32
timestampstring

400Bad Request

ReachabilityError
Example
```
{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2019-07-30T23:53:48.615Z",
  "detail": {
    "message": "Unable to parse request body."
  }
}
```
- titlestring
  Example
  Bad Request
- statusinteger
  Example
  400
  Default
  0
- timestampstring
  Example
  2018-08-07T13:44:17.659Z
- detailobject
  - messagestring

403Forbidden

curl

curl --request POST \
     --url https://api.us1.odp.optimizely.com/v3/reachability \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "identifier_value": "",
     "identifier_field_name": "",
     "reachable": true,
     "reachable_update_type": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "identifier_value": "",
   "identifier_field_name": "",
   "reachable": true,
   "reachable_update_type": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.us1.odp.optimizely.com/v3/reachability", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.us1.odp.optimizely.com/v3/reachability")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "identifier_value": "",
   "identifier_field_name": "",
   "reachable": true,
   "reachable_update_type": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.us1.odp.optimizely.com/v3/reachability"

payload = json.dumps({
   "identifier_value": "",
   "identifier_field_name": "",
   "reachable": True,
   "reachable_update_type": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

202

// Accepted
{
  "title": "",
  "status": "",
  "timestamp": ""
}

400

// Bad Request
{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-08-07T13:44:17.659Z",
  "detail": {
    "message": ""
  }
}

403

// Forbidden