Update a member

PATCH/v1/members/{id}

PATCH/v1/members/me

Changes profile fields. Send only the fields you want to change. Fields you leave out stay as they are.

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

Guide

Members and sign-in

Path parameters#

idstring (uuid)Required

Request body#

first_namestring
last_namestring
emailstring (email)
phonestring
E.164. Secret key only.
phone_verifiedboolean
Secret key only.
birthdaystring (date)
Set once from the app; a secret key can correct it.
metadataobject

Field	Secret key	Member token
`first_name`, `last_name`	Yes	Yes
`email`	Yes	Yes
`phone`, `phone_verified`	Yes	No
`birthday`	Yes, any time (to correct it)	Once, while it is `null`
`metadata`	Yes	Yes

The app can't change the phone because the phone is how a guest's register visits find their member. Verify the new number on your server, then send it with the secret key and phone_verified: true. The same phone rules as create apply: a number another linked member has returns 409 phone_in_use.

metadata keys you send are set; keys you leave out stay. The 20-key limit counts the stored keys after the update.

Response fields#

Returns 200 with Member

idstring (uuid)
unPLUG's id for the member. Store it next to your user record.
external_idstringNullable
Your id for the guest, up to 128 characters. null for a guest who has only earned at the register and isn't linked to your login yet.
Max Length 128
statusstring
active. The member.deleted webhook carries deleted; after that, calls about the member return 410 member_deleted.
One of active, deleted
first_namestringNullable
last_namestringNullable
emailstring (email)Nullable
Saved in lowercase.
phonestringNullable
E.164, for example +15125550142.
phone_verifiedboolean
true when you confirmed the guest owns the number, for example with an SMS code. Only verified phones link to existing members.
birthdaystring (date)Nullable
YYYY-MM-DD.
points_balanceinteger
Points the member has now. Never below zero.
lifetime_pointsinteger
All points ever earned, used for tiers. Spending doesn't lower it.
tierTierRef
id and name of the current tier.
Show attributesTierRef
- idstring (uuid)
- namestring
next_tierobjectNullable
id, name and points_needed (lifetime points still to earn). null at the top tier.
Show attributesHide attributes
- idstring (uuid)
- namestring
- points_neededinteger
communication_preferencesobject
Marketing consent: email_marketing, sms_marketing, push_marketing. See communication preferences.
Show attributesHide attributes
- email_marketingboolean
- sms_marketingboolean
- push_marketingboolean
metadataobject
Your own string values. Up to 20 keys, 500 characters each. Don't put personal data here.
linked_existingboolean
Only on create: true when an existing member was linked by verified phone.
enrolled_atstring (date-time)
When the guest joined the program.
created_atstring (date-time)
updated_atstring (date-time)

PATCH/v1/members/{id}

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

1
2
3
4
5
6
7
8
9const response = await fetch(`${process.env.UNPLUG_API}/members/me`, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MEMBER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ metadata: { favorite_store: "riverside" } }),
});
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",
    headers={
        "Authorization": f"Bearer {os.environ['MEMBER_TOKEN']}",
    },
    json={"metadata": {"favorite_store": "riverside"}},
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20{
  "id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
  "external_id": "usr_10482",
  "status": "active",
  "first_name": "Maya",
  "last_name": "Lopez",
  "email": "maya@example.com",
  "phone": "+15125550142",
  "phone_verified": true,
  "birthday": "1994-03-18",
  "points_balance": 420,
  "lifetime_points": 1880,
  "tier": { "id": "2b9e4f7a-1c3d-4e6b-8a5f-9d0c2e7b4a13", "name": "Green" },
  "next_tier": { "id": "6f1a8c3d-9b2e-4d7a-b5c6-3e0f8a1d2b47", "name": "Gold", "points_needed": 120 },
  "communication_preferences": { "email_marketing": true, "sms_marketing": false, "push_marketing": true },
  "metadata": { "favorite_store": "riverside" },
  "enrolled_at": "2025-06-14T15:02:44Z",
  "created_at": "2025-06-14T15:02:44Z",
  "updated_at": "2026-11-04T09:15:33Z"
}

Error descriptions#

400Bad request

invalid_param

A field has the wrong format, a member token tried to change phone, or a member token tried to change a birthday that is already set. param names the field.

404Not found

member_not_found

No member with this id.

409Conflict

phone_in_use

Another member with an external_id has this phone.

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 field has the wrong format, a member token tried to change phone, or a member token tried to change a birthday that is already set. param names the field."
}