Subscribe/Unsubscribe

1 min

POST

https://api.us1.odp.optimizely.com/v3/lists/subscriptions

Subscribe or unsubscribe a customer identifier to or from an Optimizely Data Platform (ODP) list.

Body Parameters

bodySubscriberequired
Examples
Example Payload:
{ "list_id": "sample_list", "email": "[email protected]", "subscribed": false }
- subscribedboolean
  Description
  whether or not the messaging identifier is subscribed to the list
- list_idstringrequired
  Example
  sample_list
  Description
  the name of the list

Responses

202Accepted

undefined

Example

{
  "updates": [
    {
      "list_id": "sample_list",
      "email": "[email protected]",
      "subscribed": true
    }
  ]
}

400Bad Request

undefined

Example

{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-09-10T21:07:10-05:00",
  "detail": {
    "invalids": [
      {
        "field": "delimiter",
        "reason": "Unrecognized delimiter, valid options are comma, tab or pipe"
      }
    ]
  }
}

403Forbidden

undefined
Example
```
{
  "message": "Forbidden"
}
```

404Not Found

undefined

Example

{
  "title": "Bad Request",
  "status": 404,
  "timestamp": "2018-09-10T21:07:10-05:00",
  "detail": {
    "message": "Not found description"
  }
}

curl

curl --request POST \
     --url https://api.us1.odp.optimizely.com/v3/lists/subscriptions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "list_id": "sample_list"
     }'

javascript

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

var raw = JSON.stringify({
   "list_id": "sample_list"
});

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

fetch("https://api.us1.odp.optimizely.com/v3/lists/subscriptions", 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/lists/subscriptions")

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({
   "list_id": "sample_list"
})

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

python

import requests
import json

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

payload = json.dumps({
   "list_id": "sample_list"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

202

// Accepted
"{ \"updates\": [ { \"list_id\": \"sample_list\", \"email\": \"[email protected]\", \"subscribed\": true } ] }"

400

// Bad Request
"{\"title\":\"Bad Request\",\"status\":400,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"invalids\":[{\"field\":\"delimiter\",\"reason\":\"Unrecognized delimiter, valid options are comma, tab or pipe\"}]}}"

403

// Forbidden
"{  \"message\": \"Forbidden\"}"

404

// Not Found
"{\"title\":\"Bad Request\",\"status\":404,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"message\":\"Not found description\"}}"