Get an opt-out

Returns a single opt-out and the list it belongs to.

GET

https://app.messageport.com.au/api/v2/optouts/{optout}

Authorization

basicAuth
HTTP
required

Path parameters

optout
integer
required
Opt-out ID.

Returns

200

The opt-out.

JSON

data
optional
object
- id
  optional
  integer
- user
  optional
  integer
  ID of the user that owns the opt-out.
- number
  optional
  string
  Opted-out number in E.164 format.
- method
  optional
  manual
  or
  import
  or
  link
  or
  reply
  or
  chat
  or
  api
  +2 more
  How the opt-out was created.
- opt_out_list
  optional
  object
  The list this opt-out belongs to.
  
  id
  optional
  integer
  name
  optional
  string
  is_default
  optional
  boolean
- updated
  optional
  string
  format: date-time
- created
  optional
  string
  format: date-time
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

JSON

message
string
required

{ "data": { "id": 12345, "user": 5678, "number": "+61412345678", "method": "reply", "opt_out_list": { "id": 1, "name": "Default Opt-Out List", "is_default": true }, "updated": "2024-03-11T02:14:07.000000Z", "created": "2024-03-11T02:14:07.000000Z" } }