13 operations. Every schema and example on this page is generated from the platform contract.
Newest first, with how many each reached and whether it is scheduled, sent, failed or called off.
How many, newest first. Default 5, at most 10.
What it is about: one of her drops, one of her items, or just a message.
dropitemmessageappemailsmsscheduledsendingsentfailedcancelledWhen it goes (or went). ISO.
How many people the app reached. Null until it has run.
How many emails were queued. Null until it has run.
How many people were texted. Null until it has run.
Why a way did not reach anyone, when one did not (e.g. EMAIL_UPDATES_OFF).
curl -G "https://www.membber.com/api/v1/updates" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/updates", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
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.listShopUpdates(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"updates": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "drop",
"drop_id": "72c8286b-0000-4000-8000-d0c500000072",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"title": "Morning class",
"body": "<body>",
"image_url": "https://example.com/image.jpg",
"channels": [
"app"
],
"status": "scheduled",
"scheduled_for": "<scheduled_for>",
"sent_at": "<sent_at>",
"created_at": "<created_at>",
"app_recipients": -9007199254740991,
"email_recipients": -9007199254740991,
"sms_recipients": -9007199254740991,
"error_code": "EXAMPLE10"
}
]
}/api/v1/updatesSends (or schedules) an update by app and, when it is on, email. Each person gets it once, and nobody hears from the shop twice in a day. At a limit: 429 UPDATE_LIMIT_REACHED with details.next_at. Email off: 409 CHANNEL_UNAVAILABLE. A text over the cap: 422 TEXT_TOO_LONG. Too little text credit: 402 NOT_ENOUGH_TEXTS with details.balance and details.needed. Another update still sending: 409 UPDATE_IN_FLIGHT. The same idempotency_key answers the same update. Owner, or staff allowed to message customers; never an API key.
What it is about: one of her drops, one of her items, or just a message.
dropitemmessageThe drop, when `kind` is `drop`. It must be scheduled or open.
The item, when `kind` is `item`. It must be on her menu.
The email's subject and headline. Omitted: the drop's or item's name, else the shop's.
Her words. Emoji are fine.
Its picture: an https address of one of her own photos, or one she just uploaded through the shop photo upload (`/api/upload-store-image`, `type=carousel`). Omitted: the drop's or item's own photo.
A later time she picked, at most 14 days ahead. Omitted or past: now. Quiet hours still move it to 08:00.
Remind the ones who didn't tap: one of her own updates of the last 14 days. Every way then reaches only the people it told who have not tapped its link, as today's rules still allow (an unsubscribe, a stop or a limit still wins). Refused: not hers 404 REMIND_NOT_FOUND; older than 14 days 409 REMIND_TOO_OLD; itself a reminder 409 REMIND_OF_REMINDER; reminded already 409 ALREADY_REMINDED (one reminder per update). Omitted: an ordinary update.
gone_quiet: as on the preview. ordered_it_before and not_ordered_yet (a message she adds to one drop; only with kind drop and its drop_id, never with sms, else 422): ordered_it_before reaches only people with a kept paid order holding any item that is in that drop (nobody: 409 NOBODY_ORDERED_BEFORE); not_ordered_yet reaches everyone the update would reach EXCEPT people with an order in that drop, worked out when it goes, not when it is made. Both use her normal allowance. Under the new plans they need can_schedule_updates (403 ENTITLEMENT_DENIED). Omitted: everyone.
gone_quietordered_it_beforenot_ordered_yetOnly with `audience: gone_quiet`: which Gone quiet, as her Customers page's Gone quiet sheet picks it. usual (omitted): Longer than usual. 2w, 1m, 3m, 6m: came back (2 or more paid orders) and nothing for at least 14, 30, 90 or 180 days. Worked out again when it goes. With any other audience: 422.
usual2w1m3m6mWhich ways it goes. Texts only while they are on (409 CHANNEL_UNAVAILABLE otherwise), paid from her credit.
appemailsmsMade by the client once per update and sent again on every retry: the same key is the same update, never a second send.
The texts her preview showed (people, and texts in all), when texts go. The update never texts more people nor spends more of her texts than this, nor than is counted when it is made, whichever is less. Omitted: what is counted then.
What it is about: one of her drops, one of her items, or just a message.
dropitemmessageappemailsmsscheduledsendingsentfailedcancelledWhen it goes (or went). ISO.
How many people the app reached. Null until it has run.
How many emails were queued. Null until it has run.
How many people were texted. Null until it has run.
Why a way did not reach anyone, when one did not (e.g. EMAIL_UPDATES_OFF).
curl -X POST "https://www.membber.com/api/v1/updates" \
-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",
"kind": "drop",
"body": "<body>",
"channels": [
"app"
],
"idempotency_key": "1f0e2d3c-4b5a-4678-9abc-def012345678"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/updates", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
kind: "drop",
body: "<body>",
channels: [
"app"
],
idempotency_key: "1f0e2d3c-4b5a-4678-9abc-def012345678"
},
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.sendShopUpdate(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
kind: .drop,
body: "<body>",
channels: [.app],
idempotencyKey: "1f0e2d3c-4b5a-4678-9abc-def012345678"
))
).ok.body.json
print(response){
"update": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "drop",
"drop_id": "72c8286b-0000-4000-8000-d0c500000072",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"title": "Morning class",
"body": "<body>",
"image_url": "https://example.com/image.jpg",
"channels": [
"app"
],
"status": "scheduled",
"scheduled_for": "<scheduled_for>",
"sent_at": "<sent_at>",
"created_at": "<created_at>",
"app_recipients": -9007199254740991,
"email_recipients": -9007199254740991,
"sms_recipients": -9007199254740991,
"error_code": "EXAMPLE10"
}
}Only before it starts sending. Calling off one already called off answers it as it is; one that is sending, sent or failed is refused (409 UPDATE_NOT_SCHEDULED, details.status).
What it is about: one of her drops, one of her items, or just a message.
dropitemmessageappemailsmsscheduledsendingsentfailedcancelledWhen it goes (or went). ISO.
How many people the app reached. Null until it has run.
How many emails were queued. Null until it has run.
How many people were texted. Null until it has run.
Why a way did not reach anyone, when one did not (e.g. EMAIL_UPDATES_OFF).
curl -X POST "https://www.membber.com/api/v1/updates/4ed533c4-0000-4000-8000-d0c50000004e/cancel" \
-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"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/updates/{updateId}/cancel", {
params: { path: { updateId: "4ed533c4-0000-4000-8000-d0c50000004e" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066"
},
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.cancelShopUpdate(
path: .init(updateId: "4ed533c4-0000-4000-8000-d0c50000004e"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066"
))
).ok.body.json
print(response){
"update": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "drop",
"drop_id": "72c8286b-0000-4000-8000-d0c500000072",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"title": "Morning class",
"body": "<body>",
"image_url": "https://example.com/image.jpg",
"channels": [
"app"
],
"status": "scheduled",
"scheduled_for": "<scheduled_for>",
"sent_at": "<sent_at>",
"created_at": "<created_at>",
"app_recipients": -9007199254740991,
"email_recipients": -9007199254740991,
"sms_recipients": -9007199254740991,
"error_code": "EXAMPLE10"
}
}multipart/form-data: `t` (the link token) and `file`. The link is signed for one shop and one use, and lasts 24 hours. The file must be a JPEG, PNG, WebP or GIF by its own bytes, 10 MB at most; it is kept as her own shop photo and her AI collects it with propose_send_update. A used or expired link is 410 LINK_EXPIRED; an unknown one 404. 429 PICTURE_LIMIT after 50 pictures a shop a day (a refused file uses none). The request is checked by its declared length before it is read: 411 LENGTH_REQUIRED without one, 413 TOO_BIG over 6 MB. 404 to everyone while Send an update for AI apps is off.
curl -X POST "https://www.membber.com/api/v1/updates/picture-link" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient();
const { data, error } = await membber.raw.POST("/api/v1/updates/picture-link", {
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: { nil }
)
let response = try await client.api.addUpdatePictureByLink().ok.body.json
print(response){
"added": true
}Uses the link and holds what came, for her AI to collect with propose_item_media. Nothing on the item changes: that is her yes, in her chat. A second Done answers the same. A started video that cannot be found is 409 VIDEO_NOT_HERE and the link stays open, unless `without_video`. 422 NOTHING_ADDED when nothing came. An expired link is 410 LINK_EXPIRED; an unknown one, or a link of another purpose, 404.
The token from the link.
She chose to finish with what arrived, leaving out a video that did not.
How many of her files came.
curl -X POST "https://www.membber.com/api/v1/updates/picture-link/done" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"t": "<t>"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient();
const { data, error } = await membber.raw.POST("/api/v1/updates/picture-link/done", {
body: {
t: "<t>"
},
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: { nil }
)
let response = try await client.api.finishItemMediaLink(
body: .json(.init(
t: "<t>"
))
).ok.body.json
print(response){
"added": 1,
"photos": 1,
"videos": 1
}The server names where the file waits (privately, for her shop) and signs a one-use target; her browser sends the bytes straight to storage, as her Downloads screen does. Nothing is sold and no item is made: that is her yes, in her chat. A send that failed may start again; 409 FILE_ALREADY after four tries. 422 TOO_BIG over the type's cap. A used link is 410 LINK_USED, an expired one 410 LINK_EXPIRED; an unknown one, or a link of another purpose, 404. 404 to everyone while no picture link can be on.
The token from the link.
A PDF or an MP4.
application/pdfvideo/mp4The size about to be sent, at most 50 MiB.
Her file's own name, shown only to her.
A one-use signed target: PUT the bytes here with the same Content-Type.
curl -X POST "https://www.membber.com/api/v1/updates/picture-link/file" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"t": "<t>",
"content_type": "application/pdf",
"byte_size": 1,
"filename": "<filename>"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient();
const { data, error } = await membber.raw.POST("/api/v1/updates/picture-link/file", {
body: {
t: "<t>",
content_type: "application/pdf",
byte_size: 1,
filename: "<filename>"
},
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: { nil }
)
let response = try await client.api.startDigitalFileByLink(
body: .json(.init(
t: "<t>",
contentType: .application/pdf,
byteSize: 1,
filename: "<filename>"
))
).ok.body.json
print(response){
"signed_url": "https://example.com/image.jpg",
"max_bytes": -9007199254740991
}Checks the file that arrived by its own size and first bytes (a PDF or an MP4, 50 MiB at most), then uses the link and holds the file for her AI to collect with propose_add_digital_product. A file that is not what it says is deleted at once: 422 UPLOAD_REFUSED, link still open. 409 FILE_NOT_HERE when nothing arrived. A second Done answers the same. An expired link is 410 LINK_EXPIRED; an unknown one, or a link of another purpose, 404.
The token from the link.
application/pdfvideo/mp4curl -X POST "https://www.membber.com/api/v1/updates/picture-link/file/done" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"t": "<t>"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient();
const { data, error } = await membber.raw.POST("/api/v1/updates/picture-link/file/done", {
body: {
t: "<t>"
},
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: { nil }
)
let response = try await client.api.finishDigitalFileLink(
body: .json(.init(
t: "<t>"
))
).ok.body.json
print(response){
"filename": "<filename>",
"content_type": "application/pdf",
"byte_size": -9007199254740991
}The same video path as `POST /api/v1/menu-items/videos`, for the item the link is signed for: the server names the file, her video space is asked, and a one-use signed target comes back. A send that failed may start again; 409 VIDEO_ALREADY after four tries. A used link is 410 LINK_USED, an expired one 410 LINK_EXPIRED; an unknown one, or a link of another purpose, 404. 429 PICTURE_LIMIT after 50 a shop a day. 404 to everyone while no picture link can be on.
The token from the link.
MP4, or QuickTime.
video/mp4video/quicktimeThe size about to be sent, at most 15 MiB.
PUT the bytes here with the `Content-Type` the upload was started with. Never writes over another file.
The video's public address once its bytes are up: what goes in the item's `product_media`.
curl -X POST "https://www.membber.com/api/v1/updates/picture-link/video" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"t": "<t>",
"content_type": "video/mp4",
"byte_size": 1
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient();
const { data, error } = await membber.raw.POST("/api/v1/updates/picture-link/video", {
body: {
t: "<t>",
content_type: "video/mp4",
byte_size: 1
},
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: { nil }
)
let response = try await client.api.startItemVideoByLink(
body: .json(.init(
t: "<t>",
contentType: .video/mp4,
byteSize: 1
))
).ok.body.json
print(response){
"upload": {
"path": "<path>",
"token": "<token>",
"signed_url": "https://example.com/image.jpg"
},
"url": "https://example.com/image.jpg",
"max_bytes": -9007199254740991
}What an update about a drop, an item or anything would say, how many people each way (app, email) would reach now, what is left of each way's limit, whether email is on, and when it would go. Writes nothing. Owner, or staff allowed to message customers; a signed-in person, never an API key.
What it is about: one of her drops, one of her items, or just a message.
dropitemmessageThe drop, when `kind` is `drop`. It must be scheduled or open.
The item, when `kind` is `item`. It must be on her menu.
The email's subject and headline. Omitted: the drop's or item's name, else the shop's.
Her words. Emoji are fine.
Its picture: an https address of one of her own photos, or one she just uploaded through the shop photo upload (`/api/upload-store-image`, `type=carousel`). Omitted: the drop's or item's own photo.
A later time she picked, at most 14 days ahead. Omitted or past: now. Quiet hours still move it to 08:00.
Remind the ones who didn't tap: one of her own updates of the last 14 days. Every way then reaches only the people it told who have not tapped its link, as today's rules still allow (an unsubscribe, a stop or a limit still wins). Refused: not hers 404 REMIND_NOT_FOUND; older than 14 days 409 REMIND_TOO_OLD; itself a reminder 409 REMIND_OF_REMINDER; reminded already 409 ALREADY_REMINDED (one reminder per update). Omitted: an ordinary update.
gone_quiet: only her regulars gone quiet (3 or more paid orders and none for twice their usual gap, the Customers page's Gone quiet filter), worked out again when it goes, as today's rules still allow. Only while QUIET_REGULARS_ENABLED is on (otherwise 404 NOT_FOUND). Never with remind_update_id (422). Nobody quiet when it is sent: 409 NOBODY_QUIET. Omitted: everyone.
gone_quietOnly with `audience: gone_quiet`: which Gone quiet, as her Customers page's Gone quiet sheet picks it. usual (omitted): Longer than usual. 2w, 1m, 3m, 6m: came back (2 or more paid orders) and nothing for at least 14, 30, 90 or 180 days. Worked out again when it goes. With any other audience: 422.
usual2w1m3m6mThe ways ticked (default app and email). Her drop list is planned by the ways that would run, so the ticked ways' reach adds up to what the send reaches; an unticked way shows who it would reach if ticked too.
appemailsmsWhere a tap goes: the drop's page, the item's page, else her shop page.
The in-app message as it is sent: her words, then the link.
App, email and text, in that order.
appemailsmsWhy not, when not available. Email is off until the founder switches it on; texts are off until SEND_UPDATE_SMS and the SMS key are both set.
EMAIL_UPDATES_OFFSMS_NOT_YETHow many people it would reach now. Null when not available.
What is left of this way's limit: app 2 a week (rolling), email 4 a month (the shop's month).
When one more comes back, once none are left. ISO.
When it would go. ISO.
True when it would go later than now (a time she picked, or quiet hours).
True when quiet hours (21:00 to 08:00 on the shop's clock) moved it later than asked.
The shop's clock, for saying `sends_at` in words.
What a text of it would take.
True when a character (an emoji) makes a text hold 70, not 160.
How many texts one copy takes.
At 8p a text.
Her texts and their price. Null while texts are off.
Texts she has (paid credit; never expires).
Texts one copy takes.
The most texts one copy may take. Over it a send is refused: TEXT_TOO_LONG.
Texts one copy would take with the emoji taken out of her words. Null when that saves nothing.
Texts × the text reach × 8p, drawn from her credit.
The one line shown when she buys texts.
Once drop-alert texts are metered (DROP_ALERT_TEXTS_METERED): what is left of this month's 25 free alert texts. Null before then.
Up to three initials of people it reaches by app or email, from their own names. Empty when none has a name.
A reminder (`remind_update_id`): who it goes to. Absent or null for an ordinary update.
How many of the people it told who didn't tap can still be reached, by every way that is on.
Only with `audience: gone_quiet`.
How many of her regulars gone quiet it can reach now, by every way that is on.
curl -X POST "https://www.membber.com/api/v1/updates/preview" \
-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",
"kind": "drop",
"body": "<body>"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/updates/preview", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
kind: "drop",
body: "<body>"
},
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.previewShopUpdate(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
kind: .drop,
body: "<body>"
))
).ok.body.json
print(response){
"title": "Morning class",
"body": "<body>",
"link_url": "https://example.com/image.jpg",
"image_url": "https://example.com/image.jpg",
"app_text": "<app_text>",
"channels": [
{
"channel": "app",
"available": true,
"reason": "EMAIL_UPDATES_OFF",
"reach": -9007199254740991,
"allowance": {
"limit": 25,
"used": -9007199254740991,
"remaining": -9007199254740991,
"next_at": "<next_at>"
}
}
],
"sends_at": "<sends_at>",
"scheduled": true,
"quiet_hours": true,
"time_zone": "<time_zone>",
"sms": {
"unicode": true,
"length": -9007199254740991,
"segments": -9007199254740991,
"pence_per_person": -9007199254740991
},
"texts": {
"balance": -9007199254740991,
"segments": -9007199254740991,
"cap": -9007199254740991,
"too_long": true,
"without_emoji_segments": -9007199254740991,
"price_pence": 1500,
"pence_per_text": -9007199254740991,
"terms_line": "<terms_line>",
"packs": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"texts": -9007199254740991,
"pence": -9007199254740991
}
],
"free_alert_texts_left": -9007199254740991
},
"initials": [
"<initial>"
],
"remind": {
"update_id": "8bd19851-0000-4000-8000-d0c50000008b",
"people": -9007199254740991
},
"quiet": {
"people": -9007199254740991
}
}One entry per recent update that has reached somebody (at most 3, last 14 days). Told counts the people it reached; tapped, those who tapped their own link (no tracking image); ordered and pence, paid orders at the shop within 7 days, matched by customer record, email or phone, each order credited to the latest update that reached that person. Owner, or staff who may see reports; never an API key.
At most 3, newest first, from the last 14 days; only updates that have reached somebody.
What it is about: one of her drops, one of her items, or just a message.
dropitemmessageThe drop it was about, if any.
The item it was about, if any.
The drop's or item's name (or her own title).
When it went. ISO.
People it reached, one each.
Of those, people who tapped its link. No open tracking.
Of those, people with a paid order within 7 days after it reached them.
Paid orders credited to it (each order to one update only: the latest that reached that person).
Her takings from those orders, in pence: never the buyer's booking fee; refunded, test and test-shop orders count nothing.
Remind the N who didn't tap: how many of the people it told who didn't tap can still be reached now (send an update with `remind_update_id`). 0 when nobody is left, it is older than 14 days, it is a reminder itself, it has a reminder already, or this person may not send updates.
Her own words, only for a plain message (a reminder of it opens Send an update with them). Absent for an item or a drop.
curl -G "https://www.membber.com/api/v1/updates/results" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/updates/results", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
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.listShopUpdateResults(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"results": [
{
"update_id": "8bd19851-0000-4000-8000-d0c50000008b",
"kind": "drop",
"drop_id": "72c8286b-0000-4000-8000-d0c500000072",
"menu_item_id": "ca65a6e7-0000-4000-8000-d0c5000000ca",
"title": "Morning class",
"image_url": "https://example.com/image.jpg",
"sent_at": "<sent_at>",
"told": -9007199254740991,
"tapped": -9007199254740991,
"ordered": -9007199254740991,
"orders": -9007199254740991,
"pence": -9007199254740991,
"remind": -9007199254740991,
"body": "<body>"
}
]
}Makes one PaymentIntent for one pack (50, 100 or 250 texts at 8p each) on the Membber platform account. Texts never expire. Off until texts are switched on: 409 TEXTS_OFF. Paused while the SMS provider holds fewer credits than shops hold texts, or either cannot be read: 409 TEXTS_PAUSED. Owner, or staff allowed to message customers and change settings; a signed-in person, never an API key.
Which pack: p50 (50 texts), p100 (100 texts) or p250 (250 texts), at 8p a text.
p50p100p250Made by the client once per buy sheet and sent again on a retry: the same key is the same payment, never a second charge.
The PaymentIntent client secret, for the Payment Element.
curl -X POST "https://www.membber.com/api/v1/updates/texts/buy" \
-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",
"pack": "p50",
"client_key": "<client_key>"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/updates/texts/buy", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
pack: "p50",
client_key: "<client_key>"
},
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.buyShopTexts(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
pack: .p50,
clientKey: "<client_key>"
))
).ok.body.json
print(response){
"client_secret": "<client_secret>",
"publishable_key": "<publishable_key>",
"payment_intent_id": "0b6642a5-0000-4000-8000-d0c50000000b",
"texts": -9007199254740991,
"pence": -9007199254740991
}Reads the PaymentIntent back from Stripe and adds its texts once (a second call, or the webhook, adds nothing). Off until texts are switched on: 409 TEXTS_OFF.
added: the texts are hers. pending: the payment is still settling; they arrive when it does.
addedpendingTexts she has now.
curl -X POST "https://www.membber.com/api/v1/updates/texts/confirm" \
-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",
"payment_intent_id": "0b6642a5-0000-4000-8000-d0c50000000b"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/updates/texts/confirm", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
payment_intent_id: "0b6642a5-0000-4000-8000-d0c50000000b"
},
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.confirmShopTexts(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
paymentIntentId: "0b6642a5-0000-4000-8000-d0c50000000b"
))
).ok.body.json
print(response){
"status": "added",
"texts": -9007199254740991,
"balance": -9007199254740991
}Her balance, then gifts from Membber, packs bought, refunds and take-backs, and what she spent, rolled up per update and per month of drop alerts, newest first. Off until texts are switched on: 409 TEXTS_OFF. Owner, or staff allowed to message customers; a signed-in person, never an API key.
How many rows, newest first. Default 30, at most 100.
Texts she has now.
The row's own id: a gift's is its ledger id, the key its celebration is seen under.
gift: Membber gave them. purchase: a pack she bought. refund: a pack refunded or disputed. taken_back: a gift taken back. update: what one update cost. drop_alerts: what drop alerts cost in one month. adjustment: anything else.
giftpurchaserefundtaken_backupdatedrop_alertsadjustmentWhen it happened (the latest of a rolled-up month).
Added (positive) or used (negative).
A gift's reason or a take-back's, as written; an update's title. Otherwise null.
drop_alerts only: 'YYYY-MM' on the shop's clock.
gift only: how many of its texts were taken back. Otherwise 0.
True when older rows were left out.
curl -G "https://www.membber.com/api/v1/updates/texts/history" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/updates/texts/history", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
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.listShopTextsHistory(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"balance": -9007199254740991,
"entries": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "gift",
"at": "2026-07-01T09:00:00Z",
"texts": -9007199254740991,
"label": "<label>",
"month": "<month>",
"taken_back": -9007199254740991
}
],
"more": true
}