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

Subscribe/Unsubscribe

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
  • Subscribe – Set subscribed to true .
  • Unsubscribe – Set subscribed to false .
  • Provide a single list_id for the list that you want to subscribe or unsubscribe a customer to.
  • To get the list_id, use the Get Lists endpoint.
  • This API only accepts a single identifier type and identifier value pair in the form "identifier type": "identifier value". See "email": "[email protected]" in the following example:
    {
      "subscribed": true,
      "list_id": "newsletter",
      "email": "[email protected]"
    }
  • Examples of valid identifier types: email, phone, vuid, and so on.
Body Params
boolean

whether or not the messaging identifier is subscribed to the list

string
required

the name of the list

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