Register a device

PUT/v1/members/me/devices/{device_id}

Creates or updates the device for the signed-in member. Call it on every app start, and whenever the push token, the notification permission or the signed-in member changes. Sending the same body again changes nothing. A member can have many devices. If another member registered this device_id before, the device moves to the member in the token.

Permissions: Member token.

Guide

Push and in-app messages

Path parameters#

device_idstringRequired
Your stable id for this install.

Request body#

platformstringRequired
ios or android.
One of ios, android
push_tokenstringNullable
Current push token. Send null if the app hasn't got one yet.
token_typestring
fcm or apns. Required with push_token.
One of fcm, apns
app_idstringRequired
Bundle id or package name.
push_enabledbooleanRequired
The OS notification permission right now.
app_versionstring
Your app's version.
os_versionstring
OS version.
localestring
Device language.
time_zonestring
Device time zone.

Response fields#

Returns 200 with Device

device_idstring
Your id for this install, up to 128 characters. Use a UUID you generate once and keep in app storage.
member_idstring (uuid)
The member signed in on the device.
platformstring
ios or android.
One of ios, android
push_tokenstringNullable
The push token from Firebase or APNs. null if the app has none yet.
token_typestring
fcm (from the Firebase SDK) or apns (a raw APNs token, iOS only).
One of fcm, apns
app_idstring
iOS bundle id or Android package name. Must be an app support set up for your brand.
push_enabledboolean
The OS notification permission. Marketing consent is separate: communication_preferences.push_marketing on the member.
app_versionstring
Your app's version, for example 4.2.0.
os_versionstring
For example 18.1.
localestring
BCP 47 tag, for example en-US.
time_zonestring
IANA name, for example America/Chicago. unPLUG uses it for quiet hours.
created_atstring (date-time)
First registration.
updated_atstring (date-time)
Last change.

PUT/v1/members/me/devices/{device_id}

1
2
3
4
5
6
7
8
9
10
11
12
13
14curl -X PUT https://api.unplugdining.com/v1/members/me/devices/9c7e2f14-58ab-4d3e-b1a0-6f2d8e47c935 \
  -H "Authorization: Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "ios",
    "push_token": "7f3a9c2e1b8d4f6a0c5e9b2d7f1a3c8e4b6d0f2a9c7e5b3d1f8a6c4e2b0d9f7a",
    "token_type": "apns",
    "app_id": "com.example.app",
    "push_enabled": true,
    "app_version": "4.2.0",
    "os_version": "18.1",
    "locale": "en-US",
    "time_zone": "America/Chicago"
  }'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19const response = await fetch("https://api.unplugdining.com/v1/members/me/devices/9c7e2f14-58ab-4d3e-b1a0-6f2d8e47c935", {
  method: "PUT",
  headers: {
    Authorization: "Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    platform: "ios",
    push_token: "7f3a9c2e1b8d4f6a0c5e9b2d7f1a3c8e4b6d0f2a9c7e5b3d1f8a6c4e2b0d9f7a",
    token_type: "apns",
    app_id: "com.example.app",
    push_enabled: true,
    app_version: "4.2.0",
    os_version: "18.1",
    locale: "en-US",
    time_zone: "America/Chicago",
  }),
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20import requests

response = requests.put(
    "https://api.unplugdining.com/v1/members/me/devices/9c7e2f14-58ab-4d3e-b1a0-6f2d8e47c935",
    headers={
        "Authorization": "Bearer mt_4kQ9xV2mR7tB8nW3pL6yZ1cH5fJ0dS",
    },
    json={
        "platform": "ios",
        "push_token": "7f3a9c2e1b8d4f6a0c5e9b2d7f1a3c8e4b6d0f2a9c7e5b3d1f8a6c4e2b0d9f7a",
        "token_type": "apns",
        "app_id": "com.example.app",
        "push_enabled": True,
        "app_version": "4.2.0",
        "os_version": "18.1",
        "locale": "en-US",
        "time_zone": "America/Chicago",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
  "device_id": "9c7e2f14-58ab-4d3e-b1a0-6f2d8e47c935",
  "member_id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
  "platform": "ios",
  "push_token": "7f3a9c2e1b8d4f6a0c5e9b2d7f1a3c8e4b6d0f2a9c7e5b3d1f8a6c4e2b0d9f7a",
  "token_type": "apns",
  "app_id": "com.example.app",
  "push_enabled": true,
  "app_version": "4.2.0",
  "os_version": "18.1",
  "locale": "en-US",
  "time_zone": "America/Chicago",
  "created_at": "2026-10-12T15:04:51Z",
  "updated_at": "2026-10-30T14:58:20Z"
}

Error descriptions#

400Bad request

missing_param

: platform, app_id or push_enabled is missing, or token_type is missing with a push_token.

400Bad request

invalid_param

: token_type isn't fcm or apns, apns was sent for Android, or app_id isn't an app set up for your brand.

401Unauthorized

token_expired

Get a new member token and retry.

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#missing_param",
  "title": "Bad request",
  "status": 400,
  "code": "missing_param",
  "detail": ": platform, app_id or push_enabled is missing, or token_type is missing with a push_token."
}