Update communication preferences

PATCH/v1/members/{id}/communication_preferences

PATCH/v1/members/me/communication_preferences

Changes marketing consent. Send only the flags that changed. You can't set source; unPLUG records it from the call. A communication_preferences.updated webhook fires.

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

Guide

Members and sign-in

Path parameters#

idstring (uuid)Required

Request body#

email_marketingboolean
sms_marketingboolean
push_marketingboolean

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

PATCH/v1/members/{id}/communication_preferences

1
2
3
4curl -X PATCH $UNPLUG_API/members/me/communication_preferences \
  -H "Authorization: Bearer $MEMBER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "sms_marketing": true }'

1
2
3
4
5
6
7
8
9const response = await fetch(`${process.env.UNPLUG_API}/members/me/communication_preferences`, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MEMBER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ sms_marketing: true }),
});
const data = await response.json();

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

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

Response JSON200

1
2
3
4
5
6
7{
  "email_marketing": true,
  "sms_marketing": true,
  "push_marketing": true,
  "updated_at": "2026-11-04T09:16:02Z",
  "source": "app"
}

Error descriptions#

400Bad request

invalid_param

A value isn't a boolean, or the body includes source.

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.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#invalid_param",
  "title": "Bad request",
  "status": 400,
  "code": "invalid_param",
  "detail": "A value isn't a boolean, or the body includes source."
}