Notifications

3 operations. Every schema and example on this page is generated from the platform contract.

POST/api/v1/notifications/marketing-opt-in

Record the answer to the marketing-notification ask.

Always scoped to the signed-in customer. Accepting writes the per-store opt-in; declining writes no preference row (marketing is opt-in by default, so absence already means no) but still records that the ask happened, which is what bounds it to two asks per store.

auth customer:writeop recordMarketingOptInidempotent retry rate limited errors

Request body

store_idstring · uuidrequired

The store the customer was asked about.

acceptedbooleanrequired

true = they want rewards and offers from this store on their phone.

Response, 200

okbooleanrequired

curl -X POST "https://www.membber.com/api/v1/notifications/marketing-opt-in" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "6659c139-0000-4000-8000-d0c500000066",
    "accepted": true
  }'

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.POST("/api/v1/notifications/marketing-opt-in", {
  body: {
    store_id: "6659c139-0000-4000-8000-d0c500000066",
    accepted: true
  },
  headers: { "Idempotency-Key": crypto.randomUUID() },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.recordMarketingOptIn(
    body: .json(.init(
        storeId: "6659c139-0000-4000-8000-d0c500000066",
        accepted: true
    ))
).ok.body.json

print(response)

Response, 200

{
  "ok": true
}

GET/api/v1/notifications/preferences

List the customer per-store notification preferences.

Per-store notification preferences for the signed-in customer: one row per store they have interacted with, with the mute + per-category toggles (messages, class reminders, class / voucher / stamp / membership / penalty events, marketing). Messages-muted and marketing default off; every other category defaults on.

auth customer:readop listNotificationPreferencesrate limited errors

Response, 200

preferencesarray of objectrequired

10 child fields

storeIdstringrequired

Store the preferences belong to.

storeNamestringrequired

Store display name, or 'Unknown' if unavailable.

messagesMutedbooleanrequired

Chat messages muted for this store (defaults off).

classRemindersbooleanrequired

Class reminder notifications (defaults on).

classEventsEnabledbooleanrequired

Class event notifications (defaults on).

voucherEventsEnabledbooleanrequired

Voucher event notifications (defaults on).

stampEventsEnabledbooleanrequired

Stamp event notifications (defaults on).

membershipEventsEnabledbooleanrequired

Membership event notifications (defaults on).

penaltyEventsEnabledbooleanrequired

Penalty event notifications (defaults on).

marketingEnabledbooleanrequired

Marketing notifications (defaults off).

curl -G "https://www.membber.com/api/v1/notifications/preferences" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.GET("/api/v1/notifications/preferences");

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.listNotificationPreferences().ok.body.json

print(response)

Response, 200

{
  "preferences": [
    {
      "storeId": "8fb04ddc-0000-4000-8000-d0c50000008f",
      "storeName": "<storeName>",
      "messagesMuted": true,
      "classReminders": true,
      "classEventsEnabled": true,
      "voucherEventsEnabled": true,
      "stampEventsEnabled": true,
      "membershipEventsEnabled": true,
      "penaltyEventsEnabled": true,
      "marketingEnabled": true
    }
  ]
}

POST/api/v1/notifications/preferences

Upsert the customer's per-store notification preferences.

Upsert one store's notification preferences for the signed-in customer: the mute toggle plus the per-category flags (messages, class reminders, class / voucher / stamp / membership / penalty events, marketing). Any toggle omitted from the body is left unchanged. Idempotent via the (customer_id, store_id) unique key, a repeat call merges the same row, never a duplicate.

auth customer:writeop upsertNotificationPreferenceidempotent retry rate limited errors

Request body

storeIdstringrequired

Store whose notification preferences to upsert (the target, not identity).

messagesMutedbooleanoptional

Mute chat messages for this store. Omit to leave unchanged.

classRemindersbooleanoptional

Class reminder notifications. Omit to leave unchanged.

classEventsEnabledbooleanoptional

Class event notifications. Omit to leave unchanged.

voucherEventsEnabledbooleanoptional

Voucher event notifications. Omit to leave unchanged.

stampEventsEnabledbooleanoptional

Stamp event notifications. Omit to leave unchanged.

membershipEventsEnabledbooleanoptional

Membership event notifications. Omit to leave unchanged.

penaltyEventsEnabledbooleanoptional

Penalty event notifications. Omit to leave unchanged.

marketingEnabledbooleanoptional

Marketing notifications. Omit to leave unchanged.

Response, 200

storeIdstringrequired

The store the preferences were written for.

updatedbooleanrequired

Always true on a successful upsert (the row was created or merged).

curl -X POST "https://www.membber.com/api/v1/notifications/preferences" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "storeId": "8fb04ddc-0000-4000-8000-d0c50000008f"
  }'

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.POST("/api/v1/notifications/preferences", {
  body: {
    storeId: "8fb04ddc-0000-4000-8000-d0c50000008f"
  },
  headers: { "Idempotency-Key": crypto.randomUUID() },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.upsertNotificationPreference(
    body: .json(.init(
        storeId: "8fb04ddc-0000-4000-8000-d0c50000008f"
    ))
).ok.body.json

print(response)

Response, 200

{
  "storeId": "8fb04ddc-0000-4000-8000-d0c50000008f",
  "updated": true
}