List opt-out lists

Returns all opt-out lists on your account, default lists first and then by name. Every account has at least one default list. Not paginated.

GET

https://app.messageport.com.au/api/v2/optout-lists

Authorization

basicAuth
HTTP
required

Returns

200

All opt-out lists.

JSON

data
optional
array of
object
- id
  optional
  integer
- name
  optional
  string
- is_default
  optional
  boolean
  Whether this is your default opt-out list.
- opt_out_count
  optional
  integer
  Number of opt-outs in the list.
- created_at
  optional
  string
  format: date-time
- updated_at
  optional
  string
  format: date-time
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

List opt-out lists

curl --request GET \
  --url https://app.messageport.com.au/api/v2/optout-lists \
  --header 'Authorization: Basic <credentials>'

const url = 'https://app.messageport.com.au/api/v2/optout-lists';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": [
    {
      "id": 2,
      "name": "Marketing Opt-Outs",
      "is_default": false,
      "opt_out_count": 89,
      "created_at": "2024-03-10T14:30:22.000000Z",
      "updated_at": "2024-03-15T09:45:18.000000Z"
    }
  ]
}

{
  "message": "Unauthenticated."
}