22 operations. Every schema and example on this page is generated from the platform contract.
Internal-admin. Previews made in the range (newest first, 200 at most) with their status, photos as 1-hour signed links, what she opened on each and the step it reached, and the funnel (made > sent > opened > looked around > Create your account > left a contact > setup opened > finished setup > first drop) split by channel and preview type, which is cumulative (furthest stage reached), and next to it the direct counts of what really happened (visits, Create your account tapped, Finish setup tapped, contact kept, setup opened by the admin, sign-in code asked for, account created, claims standing, first drop), narrowed by the same channel filter. Test previews are left out unless include_test. Expired previews are purged on the way in.
Previews made in the last N days, or all. Default 30d.
7d30d90d365dallcold_dmcomment_replycategory_pagein_personadasked_firstInclude test previews. Default false.
cold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropcold_dmcomment_replycategory_pagein_personadasked_firstcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropname_onlywith_photoscreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropvisitinterestedmake_it_mine_tappedcontact_givensetup_openedcode_sentaccount_createdclaimedfirst_dropcurl -G "https://www.membber.com/api/v1/admin-previews" \
-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/admin-previews");
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.adminPreviewsList().ok.body.json
print(response){
"previews": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
}
],
"truncated": true,
"funnel": {
"from": "<from>",
"to": "<to>",
"include_test": true,
"stages": [
{
"stage": "created",
"previews": 1,
"of_previous": 1,
"of_created": 1
}
],
"by_channel": [
{
"channel": "cold_dm",
"stages": [
{
"stage": "created",
"previews": 1,
"of_previous": 1,
"of_created": 1
}
]
}
],
"by_preview_type": [
{
"preview_type": "name_only",
"stages": [
{
"stage": "created",
"previews": 1,
"of_previous": 1,
"of_created": 1
}
]
}
],
"outcomes": {
"not_for_me": 1,
"not_for_me_reasons": {
"not_selling_now": 1,
"happy_with_dms": 1,
"use_something_else": 1,
"none": 1
},
"expired": 1,
"deleted": 1,
"do_not_contact": 1,
"claims_undone": 1
}
},
"actions": {
"from": "<from>",
"to": "<to>",
"include_test": true,
"counts": [
{
"action": "visit",
"previews": 1,
"total": 1
}
]
}
}Internal-admin. Refuses a handle on the do-not-contact list (409 DO_NOT_CONTACT, with the date) and a second unclaimed preview for the same handle (409 PREVIEW_EXISTS, with its id). Send an Idempotency-Key (UUID) header: a retry with the same key returns the same preview.
Her Instagram handle, with or without @, or her profile link.
Her brand colour, #RRGGBB, from her logo or website.
Her About text, verbatim from her website or Instagram bio.
Her area as she states it, e.g. "Clapham, London".
cookiescakescinnamon-bunspizzatakeawaymeal-prepfish-and-chipscoffeestreetwearbrowniescheesecakesflowerschristmascake-shedsmarket-stallsbutchersfood-vansballoonsparty-eventsothercold_dmcomment_replycategory_pagein_personadasked_firstUp to 24. No photo_id yet: photos are added after the preview exists.
captionwebsiteinstagram_mediaset_by_usunknownfixedfromA test preview (a fake handle), left out of the funnel.
Her first line for Copy message, e.g. "the piped chrysanthemums are unreal". Admin only; one line, 120 at most.
cold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcurl -X POST "https://www.membber.com/api/v1/admin-previews" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"kind": "cookies",
"channel": "cold_dm"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-previews", {
body: {
ig_handle: "<ig_handle>",
shop_name: "<shop_name>",
kind: "cookies",
channel: "cold_dm"
},
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.adminPreviewCreate(
body: .json(.init(
igHandle: "<ig_handle>",
shopName: "<shop_name>",
kind: .cookies,
channel: .coldDm
))
).ok.body.json
print(response){
"preview": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
}
}Internal-admin. Deletes an unclaimed preview, its photo rows and its stored photos. The funnel keeps an anonymous "deleted" event. A claimed preview is refused (409 PREVIEW_CLAIMED).
curl -X DELETE "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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.DELETE("/api/v1/admin-previews/{previewId}", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce" } },
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.adminPreviewDelete(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce")
).ok.body.json
print(response){
"deleted": true,
"id": "00000d1b-0000-4000-8000-d0c500000000"
}Internal-admin. Edits are refused once she has claimed it (409 PREVIEW_CLAIMED). A follow-up needs a send first (409 NOT_SENT), and there is only ever one. photo_order reorders the product photos (409 PHOTO_ORDER_MISMATCH when it is not exactly them). open_setup turns her I'm interested button into Finish setup (a draft first needs check). These refusals are checked before any field is written.
Her About text, verbatim from her website or Instagram bio.
Her area as she states it, e.g. "Clapham, London".
cookiescakescinnamon-bunspizzatakeawaymeal-prepfish-and-chipscoffeestreetwearbrowniescheesecakesflowerschristmascake-shedsmarket-stallsbutchersfood-vansballoonsparty-eventsothercold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromHer first line for Copy message; null or blank clears it.
Make it live: the founder has reviewed the draft. Until then its link is not found, and it cannot be marked sent.
Open setup: her button stops saying I'm interested and the same link says Finish setup. A draft must be made live first (409 NOT_CHECKED). Repeats are no-ops.
Record that the founder sent the link, or sent the one follow-up. Repeats are no-ops.
sentfollowed_upThe preview's product photo ids in their new order: exactly its product photos, each once (409 PHOTO_ORDER_MISMATCH otherwise, and nothing is written).
cold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcurl -X PATCH "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "cookies",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4"
}
],
"dm_opener": "<dm_opener>",
"check": true,
"open_setup": true,
"mark": "sent",
"photo_order": [
"55da3b01-0000-4000-8000-d0c500000055"
]
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PATCH("/api/v1/admin-previews/{previewId}", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce" } },
body: {
shop_name: "<shop_name>",
brand_color: "<brand_color>",
about: "<about>",
area: "<area>",
kind: "cookies",
channel: "cold_dm",
items: [
{
name: "Example name",
price_pence: 1500,
price_from_caption: true,
photo_id: "b40c2e48-0000-4000-8000-d0c5000000b4"
}
],
dm_opener: "<dm_opener>",
check: true,
open_setup: true,
mark: "sent",
photo_order: [
"55da3b01-0000-4000-8000-d0c500000055"
]
},
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.adminPreviewUpdate(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce"),
body: .json(.init(
shopName: "<shop_name>",
brandColor: "<brand_color>",
about: "<about>",
area: "<area>",
kind: .cookies,
channel: .coldDm,
items: [.init(
name: "Example name",
pricePence: 1500,
priceFromCaption: true,
photoId: "b40c2e48-0000-4000-8000-d0c5000000b4"
)],
dmOpener: "<dm_opener>",
check: true,
openSetup: true,
mark: .sent,
photoOrder: ["55da3b01-0000-4000-8000-d0c500000055"]
))
).ok.body.json
print(response){
"preview": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
}
}Internal-admin. One preview's history: when it was marked sent and followed up, its running open totals, each visit (one page load, never a person) with what was opened and tapped in it in the order the server received it (an item by its current name, or marked renamed or removed), every dated event, and the real outcomes (account created, claim standing, first drop). All times UTC ISO. Read only: it marks nothing. 404 once the preview is gone.
openedmenu_openeditem_openeddrop_openedmore_info_openedfirst_to_know_tappedinterestedcontact_givenmake_it_mine_tappedcode_sentcurrentrenamed_or_removedcreatedmarked_sentfollowed_upopenedmake_it_mine_tappedcode_sentcode_verifiedclaimednot_for_meexpireddeleteddo_not_contactclaim_undoneownership_verifiedinterestedcontact_givensetup_openedmenu_openeditem_openeddrop_openedmore_info_openedfirst_to_know_tappedaccount_createdfirst_dropcurl -G "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce/activity" \
-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/admin-previews/{previewId}/activity", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce" } },
});
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.adminPreviewActivity(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce")
).ok.body.json
print(response){
"preview_id": "fd8498f2-0000-4000-8000-d0c5000000fd",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"opens": {
"count": 1,
"first_at": "<first_at>",
"last_at": "<last_at>"
},
"visit_count": 1,
"visits": [
{
"started_at": "<started_at>",
"opened_at": "<opened_at>",
"events": [
{
"event": "opened",
"item": {
"ref": "<ref>",
"name": "Example name",
"status": "current"
},
"received_at": "<received_at>"
}
]
}
],
"events": [
{
"event": "created",
"occurred_at": "<occurred_at>"
}
],
"outcomes": {
"account_created_at": "<account_created_at>",
"claimed_at": "<claimed_at>",
"first_drop_at": "<first_drop_at>"
}
}Internal-admin. Records that the founder saw her proof code arrive from the Instagram account the preview was made for (ownership_verified_at, once; audited). 409 NOT_CLAIMED while unclaimed. A repeat changes nothing.
cold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcurl -X POST "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce/ownership-verified" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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/admin-previews/{previewId}/ownership-verified", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce" } },
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.adminPreviewOwnershipVerified(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce")
).ok.body.json
print(response){
"preview": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
}
}Internal-admin. The path is minted by the server under previews/<previewId>/ in the PRIVATE bucket drops-previews. JPEG, PNG or WebP up to 5 MB. Refused when the role is already full (1 logo, 28 products).
logoproductimage/jpegimage/pngimage/webpcurl -X POST "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce/photos" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"role": "logo",
"content_type": "image/jpeg",
"byte_size": 1
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-previews/{previewId}/photos", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce" } },
body: {
role: "logo",
content_type: "image/jpeg",
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: { session.accessToken }
)
let response = try await client.api.adminPreviewPhotoUpload(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce"),
body: .json(.init(
role: .logo,
contentType: .image/jpeg,
byteSize: 1
))
).ok.body.json
print(response){
"path": "<path>",
"token": "<token>",
"signed_url": "https://example.com/image.jpg"
}Internal-admin. Removes the photo row and its stored object; an item that used it loses its photo.
cold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcurl -X DELETE "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce/photos/dc8482ed-0000-4000-8000-d0c5000000dc" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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.DELETE("/api/v1/admin-previews/{previewId}/photos/{photoId}", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce", photoId: "dc8482ed-0000-4000-8000-d0c5000000dc" } },
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.adminPreviewPhotoDelete(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce", photoId: "dc8482ed-0000-4000-8000-d0c5000000dc")
).ok.body.json
print(response){
"preview": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
}
}Internal-admin. Checks the stored object exists, is an allowed image type (by its first bytes, not only its declared type) and is within 5 MB, then attaches it (1 logo, 28 products). A bad or surplus upload is removed from storage. A retry with the same path returns the same preview.
logoproductcold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcurl -X POST "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce/photos/confirm" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"path": "<path>",
"role": "logo"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-previews/{previewId}/photos/confirm", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce" } },
body: {
path: "<path>",
role: "logo"
},
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.adminPreviewPhotoConfirm(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce"),
body: .json(.init(
path: "<path>",
role: .logo
))
).ok.body.json
print(response){
"preview": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
}
}Internal-admin. Detaches the claim, gives the preview a NEW private link (a forwarded link dies) and a fresh 30 days, removes from the store exactly the photos the claim copied into it (her logo only while it is still that file) and puts those photos back on the preview. Photos she did not keep were deleted at the claim and do not come back. The store itself is never deleted: reject that signup the usual way. 409 NOT_CLAIMED while unclaimed. Audited.
cold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcurl -X POST "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce/undo-claim" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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/admin-previews/{previewId}/undo-claim", {
params: { path: { previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce" } },
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.adminPreviewUndoClaim(
path: .init(previewId: "ce5f1b03-0000-4000-8000-d0c5000000ce")
).ok.body.json
print(response){
"undone": true,
"id": "00000d1b-0000-4000-8000-d0c500000000",
"reopened": true,
"photos_removed": 1,
"photos_restored": 1,
"logo_removed": true,
"preview": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
}
}Internal-admin, the extension’s "Test the key" button. 200 with the key’s hint and expiry, or 401 INTAKE_TOKEN_* saying what is wrong with it.
curl -G "https://www.membber.com/api/v1/admin-previews/browser-intake" \
-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/admin-previews/browser-intake");
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.adminPreviewBrowserIntakeStatus().ok.body.json
print(response){
"ok": true,
"hint": "<hint>",
"expires_at": "<expires_at>"
}Internal-admin, called ONLY by the founder’s Chrome extension with `Authorization: Bearer mpv_…` (his intake key, made in admin). multipart/form-data: `meta` (JSON), `logo`, `photo_0`…`photo_11`. The do-not-contact list is checked FIRST: a handle on it is refused (409 DO_NOT_CONTACT) and nothing is stored. An unclaimed preview for the handle is refused (409 PREVIEW_EXISTS). Otherwise an intake is made (gone within 24 hours), every photo is re-encoded into the PRIVATE bucket, the kind is guessed from the bio (the bio is not stored) and the best 6 photos are pre-ticked.
curl -X POST "https://www.membber.com/api/v1/admin-previews/browser-intake" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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/admin-previews/browser-intake", {
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.adminPreviewBrowserIntake().ok.body.json
print(response){
"intake_id": "16beeb0e-0000-4000-8000-d0c500000016",
"review_url": "https://example.com/image.jpg",
"expires_at": "<expires_at>",
"ig_handle": "<ig_handle>",
"kind_guess": "<kind_guess>",
"photos": 1,
"preselected": 1,
"skipped": 1,
"replaced": true
}Internal-admin. The button stops working until a new key is made and pasted in.
curl -X DELETE "https://www.membber.com/api/v1/admin-previews/browser-token" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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.DELETE("/api/v1/admin-previews/browser-token", {
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.adminPreviewBrowserTokenRevoke().ok.body.json
print(response){
"revoked": true
}Internal-admin. The live key’s last 4 characters and dates, never the key itself.
curl -G "https://www.membber.com/api/v1/admin-previews/browser-token" \
-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/admin-previews/browser-token");
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.adminPreviewBrowserTokenGet().ok.body.json
print(response){
"status": {
"hint": "<hint>",
"created_at": "<created_at>",
"expires_at": "<expires_at>",
"last_used_at": "<last_used_at>"
}
}Internal-admin. Returns the key once (paste it into the extension’s Options). Any live key of yours stops working at the same moment. Keys last 90 days.
curl -X POST "https://www.membber.com/api/v1/admin-previews/browser-token" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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/admin-previews/browser-token", {
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.adminPreviewBrowserTokenMint().ok.body.json
print(response){
"token": "<token>",
"status": {
"hint": "<hint>",
"created_at": "<created_at>",
"expires_at": "<expires_at>",
"last_used_at": "<last_used_at>"
},
"revoked_previous": true
}Internal-admin. Newest first, 200 at most. Handle, source and date only.
Handle search (contains).
not_for_mestop_replyadmincurl -G "https://www.membber.com/api/v1/admin-previews/do-not-contact" \
-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/admin-previews/do-not-contact");
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.adminPreviewDncList().ok.body.json
print(response){
"entries": [
{
"ig_handle": "<ig_handle>",
"source": "not_for_me",
"added_at": "<added_at>"
}
],
"truncated": true
}Internal-admin. Adds the handle (she replied STOP, or the founder decided). Any unclaimed preview for the handle is deleted with it, photos included. Idempotent: an existing entry keeps its first date.
stop_replyadminnot_for_mestop_replyadmincurl -X POST "https://www.membber.com/api/v1/admin-previews/do-not-contact" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"ig_handle": "<ig_handle>",
"source": "stop_reply"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-previews/do-not-contact", {
body: {
ig_handle: "<ig_handle>",
source: "stop_reply"
},
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.adminPreviewDncAdd(
body: .json(.init(
igHandle: "<ig_handle>",
source: .stopReply
))
).ok.body.json
print(response){
"entry": {
"ig_handle": "<ig_handle>",
"source": "not_for_me",
"added_at": "<added_at>"
},
"already": true,
"deleted_preview_id": "eb13e4d8-0000-4000-8000-d0c5000000eb"
}Internal-admin. Read only. Says whether the typed handle is a valid Instagram handle, whether it is on the do-not-contact list (with the date), and whether she already has a preview, so the New preview sheet can refuse in words before the founder types anything else. The create re-checks both.
What the founder has typed so far: a handle, with or without @, or her profile link.
not_for_mestop_replyadmindraftsentopenedclaimedliveexpiredcurl -G "https://www.membber.com/api/v1/admin-previews/handle-check" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "handle=<handle>"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/admin-previews/handle-check", {
params: { query: { handle: "<handle>" } },
});
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.adminPreviewHandleCheck(
query: .init(handle: "<handle>")
).ok.body.json
print(response){
"ig_handle": "<ig_handle>",
"do_not_contact": {
"added_at": "<added_at>",
"source": "not_for_me"
},
"existing": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"status": "draft",
"is_test": true,
"created_at": "<created_at>"
}
}Internal-admin. Newest first, 50 at most. Each expires 23 hours after it arrived and is deleted within 24.
curl -G "https://www.membber.com/api/v1/admin-previews/intakes" \
-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/admin-previews/intakes");
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.adminPreviewIntakesList().ok.body.json
print(response){
"intakes": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"ig_handle": "<ig_handle>",
"display_name": "<display_name>",
"kind_guess": "<kind_guess>",
"photos": 1,
"created_at": "<created_at>",
"expires_at": "<expires_at>",
"logo_url": "https://example.com/image.jpg"
}
]
}Internal-admin. Deletes the intake and every photo it brought, at once.
curl -X DELETE "https://www.membber.com/api/v1/admin-previews/intakes/21c41567-0000-4000-8000-d0c500000021" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "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.DELETE("/api/v1/admin-previews/intakes/{intakeId}", {
params: { path: { intakeId: "21c41567-0000-4000-8000-d0c500000021" } },
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.adminPreviewIntakeDiscard(
path: .init(intakeId: "21c41567-0000-4000-8000-d0c500000021")
).ok.body.json
print(response){
"discarded": true,
"id": "00000d1b-0000-4000-8000-d0c500000000"
}Internal-admin. Her handle, the display name, the guessed kind and why, and the photos (1-hour signed links) with the best 6 pre-ticked. `blocked` says if Create would be refused now (do-not-contact, or a preview already made for her).
DO_NOT_CONTACTPREVIEW_EXISTSlogoproductcurl -G "https://www.membber.com/api/v1/admin-previews/intakes/21c41567-0000-4000-8000-d0c500000021" \
-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/admin-previews/intakes/{intakeId}", {
params: { path: { intakeId: "21c41567-0000-4000-8000-d0c500000021" } },
});
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.adminPreviewIntakeGet(
path: .init(intakeId: "21c41567-0000-4000-8000-d0c500000021")
).ok.body.json
print(response){
"intake": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"ig_handle": "<ig_handle>",
"display_name": "<display_name>",
"kind_guess": "<kind_guess>",
"kind_matched": [
"<kind_matched>"
],
"is_test": true,
"created_at": "<created_at>",
"expires_at": "<expires_at>",
"preview_id": "fd8498f2-0000-4000-8000-d0c5000000fd",
"blocked": {
"code": "DO_NOT_CONTACT",
"added_at": "<added_at>",
"preview_id": "fd8498f2-0000-4000-8000-d0c5000000fd"
},
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"position": 1,
"width": 1,
"height": 1,
"score": 1,
"preselected": true,
"from_reel": true,
"may_show_people": true,
"near_duplicate": true,
"url": "https://example.com/image.jpg"
}
]
}
}Internal-admin. Makes the same private preview the manual path makes (same checks: do-not-contact, one unclaimed preview per handle), then moves the ticked photos into it through the same photo checks, then sets its items (each pointed at its photo, now in the preview; a photo that did not come across leaves that item with no photo). An item pointing at a photo that is not ticked is refused before anything is made (400 INVALID_ITEMS). Idempotent: pressing it again resumes (the intake id is the create Idempotency-Key), and sets the items again. The intake and its unticked photos are deleted once every ticked photo is in and the items are set.
cookiescakescinnamon-bunspizzatakeawaymeal-prepfish-and-chipscoffeestreetwearbrowniescheesecakesflowerschristmascake-shedsmarket-stallsbutchersfood-vansballoonsparty-eventsothercold_dmcomment_replycategory_pagein_personadasked_firstHer profile picture as the logo, or null for none.
The ticked photos, in the order the preview shows them.
Up to 3 things she sells, for the preview’s drop card. Each `photo_id` is the id of one of THIS intake’s photos (not a preview photo), and it must be among `product_photo_ids`, or null for no photo (400 INVALID_ITEMS otherwise). The server points it at that photo once it has moved into the preview. A price only with `price_from_caption` (her own caption stated it). Left out: no items.
captionwebsiteinstagram_mediaset_by_usunknownfixedfromcold_dmcomment_replycategory_pagein_personadasked_firstcaptionwebsiteinstagram_mediaset_by_usunknownfixedfromcreatedmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_dropemailphonedraftsentopenedclaimedliveexpiredname_onlywith_photosdm_codeinstagramlogoproductcurl -X POST "https://www.membber.com/api/v1/admin-previews/intakes/21c41567-0000-4000-8000-d0c500000021/create" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"shop_name": "<shop_name>",
"kind": "cookies",
"channel": "cold_dm",
"is_test": true,
"logo_photo_id": "829aca5c-0000-4000-8000-d0c500000082",
"product_photo_ids": [
"5139af98-0000-4000-8000-d0c500000051"
]
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-previews/intakes/{intakeId}/create", {
params: { path: { intakeId: "21c41567-0000-4000-8000-d0c500000021" } },
body: {
shop_name: "<shop_name>",
kind: "cookies",
channel: "cold_dm",
is_test: true,
logo_photo_id: "829aca5c-0000-4000-8000-d0c500000082",
product_photo_ids: [
"5139af98-0000-4000-8000-d0c500000051"
]
},
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.adminPreviewIntakeCreate(
path: .init(intakeId: "21c41567-0000-4000-8000-d0c500000021"),
body: .json(.init(
shopName: "<shop_name>",
kind: .cookies,
channel: .coldDm,
isTest: true,
logoPhotoId: "829aca5c-0000-4000-8000-d0c500000082",
productPhotoIds: ["5139af98-0000-4000-8000-d0c500000051"]
))
).ok.body.json
print(response){
"preview": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"url": "https://example.com/image.jpg",
"short_url": "https://example.com/image.jpg",
"ig_handle": "<ig_handle>",
"shop_name": "<shop_name>",
"brand_color": "<brand_color>",
"about": "<about>",
"area": "<area>",
"kind": "<kind>",
"channel": "cold_dm",
"items": [
{
"name": "Example name",
"price_pence": 1500,
"price_from_caption": true,
"photo_id": "b40c2e48-0000-4000-8000-d0c5000000b4",
"description": "Added at the front desk",
"price_source": "caption",
"source_url": "https://example.com/image.jpg",
"price_kind": "fixed",
"price_suffix": "<price_suffix>",
"category": "<category>",
"in_drop": true,
"enquire": true
}
],
"is_test": true,
"checked": true,
"checked_at": "<checked_at>",
"review_query": "<review_query>",
"test_query": "<test_query>",
"setup_open": true,
"setup_open_at": "<setup_open_at>",
"interested_at": "<interested_at>",
"dm_opener": "<dm_opener>",
"looked_at": {
"menu": 1,
"item": 1,
"drop": 1,
"more_info": 1,
"first_to_know": 1
},
"reached": "created",
"interest_contact": {
"kind": "email",
"value": "<value>",
"given_at": "<given_at>"
},
"status": "draft",
"preview_type": "name_only",
"expires_at": "<expires_at>",
"expires_in_days": 1,
"created_at": "<created_at>",
"updated_at": "<updated_at>",
"sent_at": "<sent_at>",
"followed_up_at": "<followed_up_at>",
"first_opened_at": "<first_opened_at>",
"last_opened_at": "<last_opened_at>",
"open_count": 1,
"claimed_at": "<claimed_at>",
"claimed_store_id": "6a0dc31d-0000-4000-8000-d0c50000006a",
"ownership_verified_at": "<ownership_verified_at>",
"ownership_verified_via": "dm_code",
"claim_undone_at": "<claim_undone_at>",
"photos": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"role": "logo",
"sort": 1,
"width": 1,
"height": 1,
"url": "https://example.com/image.jpg",
"created_at": "<created_at>"
}
],
"claim": {
"proof_code": "EXAMPLE10",
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"drops_link": "<drops_link>",
"went_live_at": "<went_live_at>",
"is_test": true
},
"photos_kept": 1
}
},
"photos_attached": 1,
"photos_failed": 1,
"intake_kept": true
}