Get communication preferences

GET/v1/members/{id}/communication_preferences

GET/v1/members/me/communication_preferences

Returns the member's marketing consent and where it was last changed. unPLUG reads the same values before it sends email, SMS or push campaigns.

Field	Description
`email_marketing`boolean	Marketing email.
`sms_marketing`boolean	Marketing SMS.
`push_marketing`boolean	Marketing push. Separate from the device's OS permission, which you send as `push_enabled` on devices.
`updated_at`string	Last change.
`source`string	Set by unPLUG: `app`, `web`, `api` or `unsubscribe_link`. May grow.

Permissions: {id}: secret key with members:read. me: member token.

Guide

Members and sign-in

Path parameters#

idstring (uuid)Required

Response fields#

Returns 200 with CommunicationPreferences

email_marketingboolean
sms_marketingboolean
push_marketingboolean
updated_atstring (date-time)
sourcestring
Set automatically.
One of app, web, api, unsubscribe_link

GET/v1/members/{id}/communication_preferences

1
2curl $UNPLUG_API/members/me/communication_preferences \
  -H "Authorization: Bearer $MEMBER_TOKEN"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/members/me/communication_preferences`, {
  headers: {
    Authorization: `Bearer ${process.env.MEMBER_TOKEN}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    f"{os.environ['UNPLUG_API']}/members/me/communication_preferences",
    headers={
        "Authorization": f"Bearer {os.environ['MEMBER_TOKEN']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7{
  "email_marketing": true,
  "sms_marketing": false,
  "push_marketing": true,
  "updated_at": "2025-06-14T15:02:44Z",
  "source": "api"
}

Error descriptions#

404Not found

member_not_found

No member with this id.

410Gone

member_deleted

The member was deleted.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#member_not_found",
  "title": "Not found",
  "status": 404,
  "code": "member_not_found",
  "detail": "No member with this id."
}