API referenceAdmin previews

Admin previews

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

Previews: list and funnel.

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.

Parameters

rangeenumqueryoptional

Previews made in the last N days, or all. Default 30d.

7d30d90d365dall
channelenumqueryoptional
cold_dmcomment_replycategory_pagein_personadasked_first
include_testbooleanqueryoptional

Include test previews. Default false.

Response, 200

previewsarray of objectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
truncatedbooleanrequired
funnelobjectrequired
7 child fields
fromstringrequired
tostringrequired
include_testbooleanrequired
stagesarray of objectrequired
4 child fields
stageenumrequired
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
previewsnumberrequired
of_previousnumber, nullablerequired
of_creatednumber, nullablerequired
by_channelarray of objectrequired
2 child fields
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
stagesarray of objectrequired
4 child fields
stageenumrequired
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
previewsnumberrequired
of_previousnumber, nullablerequired
of_creatednumber, nullablerequired
by_preview_typearray of objectrequired
2 child fields
preview_typeenumrequired
name_onlywith_photos
stagesarray of objectrequired
4 child fields
stageenumrequired
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
previewsnumberrequired
of_previousnumber, nullablerequired
of_creatednumber, nullablerequired
outcomesobjectrequired
6 child fields
not_for_menumberrequired
not_for_me_reasonsobjectrequired
4 child fields
not_selling_nownumberrequired
happy_with_dmsnumberrequired
use_something_elsenumberrequired
nonenumberrequired
expirednumberrequired
deletednumberrequired
do_not_contactnumberrequired
claims_undonenumberrequired
actionsobjectrequired
4 child fields
fromstringrequired
tostringrequired
include_testbooleanrequired
countsarray of objectrequired
3 child fields
actionenumrequired
visitinterestedmake_it_mine_tappedcontact_givensetup_openedcode_sentaccount_createdclaimedfirst_drop
previewsnumberrequired
totalnumberrequired
curl -G "https://www.membber.com/api/v1/admin-previews" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "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
      }
    ]
  }
}

Previews: make one.

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.

Request body

ig_handlestringrequired

Her Instagram handle, with or without @, or her profile link.

shop_namestringrequired
brand_colorstringoptional

Her brand colour, #RRGGBB, from her logo or website.

aboutstringoptional

Her About text, verbatim from her website or Instagram bio.

areastringoptional

Her area as she states it, e.g. "Clapham, London".

kindenumrequired
cookiescakescinnamon-bunspizzatakeawaymeal-prepfish-and-chipscoffeestreetwearbrowniescheesecakesflowerschristmascake-shedsmarket-stallsbutchersfood-vansballoonsparty-eventsother
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectoptional

Up to 24. No photo_id yet: photos are added after the preview exists.

12 child fields
namestringrequired
price_penceinteger, nullablerequired
price_from_captionbooleanrequired
photo_idstring · uuid, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstring · urioptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanoptional

A test preview (a fake handle), left out of the funnel.

dm_openerstringoptional

Her first line for Copy message, e.g. "the piped chrysanthemums are unreal". Admin only; one line, 120 at most.

Response, 200

previewobjectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
curl -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"
  }'
Response, 200
{
  "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
    }
  }
}

Previews: delete one now.

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).

Parameters

previewIdstringpathrequired

Response, 200

deletedbooleanrequired
idstringrequired
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"
Response, 200
{
  "deleted": true,
  "id": "00000d1b-0000-4000-8000-d0c500000000"
}

Previews: edit one, make it live, open her setup, or mark it sent / followed up.

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.

Parameters

previewIdstringpathrequired

Request body

shop_namestringoptional
brand_colorstring, nullableoptional
aboutstring, nullableoptional

Her About text, verbatim from her website or Instagram bio.

areastring, nullableoptional

Her area as she states it, e.g. "Clapham, London".

kindenumoptional
cookiescakescinnamon-bunspizzatakeawaymeal-prepfish-and-chipscoffeestreetwearbrowniescheesecakesflowerschristmascake-shedsmarket-stallsbutchersfood-vansballoonsparty-eventsother
channelenumoptional
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectoptional
12 child fields
namestringrequired
price_penceinteger, nullablerequired
price_from_captionbooleanrequired
photo_idstring · uuid, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstring · urioptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
dm_openerstring, nullableoptional

Her first line for Copy message; null or blank clears it.

checkbooleanoptional

Make it live: the founder has reviewed the draft. Until then its link is not found, and it cannot be marked sent.

open_setupbooleanoptional

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.

markenumoptional

Record that the founder sent the link, or sent the one follow-up. Repeats are no-ops.

sentfollowed_up
photo_orderarray of string · uuidoptional

The preview's product photo ids in their new order: exactly its product photos, each once (409 PHOTO_ORDER_MISMATCH otherwise, and nothing is written).

Response, 200

previewobjectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
curl -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"
    ]
  }'
Response, 200
{
  "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
    }
  }
}

Previews: one preview's dated visits, events and real outcomes.

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.

Parameters

previewIdstringpathrequired

Response, 200

preview_idstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
opensobjectrequired
3 child fields
countnumberrequired
first_atstring, nullablerequired
last_atstring, nullablerequired
visit_countnumberrequired
visitsarray of objectrequired
3 child fields
started_atstringrequired
opened_atstring, nullablerequired
eventsarray of objectrequired
3 child fields
eventenumrequired
openedmenu_openeditem_openeddrop_openedmore_info_openedfirst_to_know_tappedinterestedcontact_givenmake_it_mine_tappedcode_sent
itemobjectrequired
3 child fields
refstringrequired
namestring, nullablerequired
statusenumrequired
currentrenamed_or_removed
received_atstringrequired
eventsarray of objectrequired
2 child fields
eventenumrequired
createdmarked_sentfollowed_upopenedmake_it_mine_tappedcode_sentcode_verifiedclaimednot_for_meexpireddeleteddo_not_contactclaim_undoneownership_verifiedinterestedcontact_givensetup_openedmenu_openeditem_openeddrop_openedmore_info_openedfirst_to_know_tappedaccount_createdfirst_drop
occurred_atstringrequired
outcomesobjectrequired
3 child fields
account_created_atstring, nullablerequired
claimed_atstring, nullablerequired
first_drop_atstring, nullablerequired
curl -G "https://www.membber.com/api/v1/admin-previews/ce5f1b03-0000-4000-8000-d0c5000000ce/activity" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "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>"
  }
}

Previews: she sent the proof code from her Instagram account.

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.

Parameters

previewIdstringpathrequired

Response, 200

previewobjectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
curl -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"
Response, 200
{
  "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
    }
  }
}

Previews: get a one-use upload link for a photo.

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).

Parameters

previewIdstringpathrequired

Request body

roleenumrequired
logoproduct
content_typeenumrequired
image/jpegimage/pngimage/webp
byte_sizeintegerrequired

Response, 200

pathstringrequired
tokenstringrequired
signed_urlstringrequired
curl -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
  }'
Response, 200
{
  "path": "<path>",
  "token": "<token>",
  "signed_url": "https://example.com/image.jpg"
}

Previews: remove a photo.

Internal-admin. Removes the photo row and its stored object; an item that used it loses its photo.

Parameters

previewIdstringpathrequired
photoIdstringpathrequired

Response, 200

previewobjectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
curl -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"
Response, 200
{
  "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
    }
  }
}

Previews: attach an uploaded photo.

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.

Parameters

previewIdstringpathrequired

Request body

pathstringrequired
roleenumrequired
logoproduct
widthintegeroptional
heightintegeroptional

Response, 200

previewobjectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
curl -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"
  }'
Response, 200
{
  "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
    }
  }
}

Previews: undo a claim (a forwarded link was claimed by the wrong person).

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.

Parameters

previewIdstringpathrequired

Response, 200

undonebooleanrequired
idstringrequired
reopenedbooleanrequired
photos_removednumberrequired
photos_restorednumberrequired
logo_removedbooleanrequired
previewobjectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
curl -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"
Response, 200
{
  "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
    }
  }
}

Previews: does the Chrome button’s key work?

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.

auth internal-adminop adminPreviewBrowserIntakeStatusrate limitederrors

Response, 200

okbooleanrequired
hintstringrequired
expires_atstringrequired
curl -G "https://www.membber.com/api/v1/admin-previews/browser-intake" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "ok": true,
  "hint": "<hint>",
  "expires_at": "<expires_at>"
}

Previews: what the Chrome button read from a maker’s profile.

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.

Response, 200

intake_idstringrequired
review_urlstringrequired
expires_atstringrequired
ig_handlestringrequired
kind_guessstringrequired
photosnumberrequired
preselectednumberrequired
skippednumberrequired
replacedbooleanrequired
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"
Response, 200
{
  "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
}

Previews: turn the Chrome button’s key off.

Internal-admin. The button stops working until a new key is made and pasted in.

Response, 200

revokedbooleanrequired
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"
Response, 200
{
  "revoked": true
}

Previews: is there a live key for the Chrome button?

Internal-admin. The live key’s last 4 characters and dates, never the key itself.

auth internal-adminop adminPreviewBrowserTokenGetrate limitederrors

Response, 200

statusobjectrequired
4 child fields
hintstringrequired
created_atstringrequired
expires_atstringrequired
last_used_atstring, nullablerequired
curl -G "https://www.membber.com/api/v1/admin-previews/browser-token" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "status": {
    "hint": "<hint>",
    "created_at": "<created_at>",
    "expires_at": "<expires_at>",
    "last_used_at": "<last_used_at>"
  }
}

Previews: make a new key for the Chrome button.

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.

Response, 200

tokenstringrequired
statusobjectrequired
4 child fields
hintstringrequired
created_atstringrequired
expires_atstringrequired
last_used_atstring, nullablerequired
revoked_previousbooleanrequired
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"
Response, 200
{
  "token": "<token>",
  "status": {
    "hint": "<hint>",
    "created_at": "<created_at>",
    "expires_at": "<expires_at>",
    "last_used_at": "<last_used_at>"
  },
  "revoked_previous": true
}

Previews: the do-not-contact list.

Internal-admin. Newest first, 200 at most. Handle, source and date only.

Parameters

qstringqueryoptional

Handle search (contains).

Response, 200

entriesarray of objectrequired
3 child fields
ig_handlestringrequired
sourceenumrequired
not_for_mestop_replyadmin
added_atstringrequired
truncatedbooleanrequired
curl -G "https://www.membber.com/api/v1/admin-previews/do-not-contact" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "entries": [
    {
      "ig_handle": "<ig_handle>",
      "source": "not_for_me",
      "added_at": "<added_at>"
    }
  ],
  "truncated": true
}

Previews: never contact this handle again.

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.

Request body

ig_handlestringrequired
sourceenumrequired
stop_replyadmin

Response, 200

entryobjectrequired
3 child fields
ig_handlestringrequired
sourceenumrequired
not_for_mestop_replyadmin
added_atstringrequired
alreadybooleanrequired
deleted_preview_idstring, nullablerequired
curl -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"
  }'
Response, 200
{
  "entry": {
    "ig_handle": "<ig_handle>",
    "source": "not_for_me",
    "added_at": "<added_at>"
  },
  "already": true,
  "deleted_preview_id": "eb13e4d8-0000-4000-8000-d0c5000000eb"
}

Previews: check a handle before making one.

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.

auth internal-adminop adminPreviewHandleCheckrate limitederrors

Parameters

handlestringqueryrequired

What the founder has typed so far: a handle, with or without @, or her profile link.

Response, 200

ig_handlestring, nullablerequired
do_not_contactobjectrequired
2 child fields
added_atstringrequired
sourceenumrequired
not_for_mestop_replyadmin
existingobjectrequired
6 child fields
idstringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
statusenumrequired
draftsentopenedclaimedliveexpired
is_testbooleanrequired
created_atstringrequired
curl -G "https://www.membber.com/api/v1/admin-previews/handle-check" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  --data-urlencode "handle=<handle>"
Response, 200
{
  "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>"
  }
}

Previews: profiles the Chrome button sent, waiting for review.

Internal-admin. Newest first, 50 at most. Each expires 23 hours after it arrived and is deleted within 24.

auth internal-adminop adminPreviewIntakesListrate limitederrors

Response, 200

intakesarray of objectrequired
8 child fields
idstringrequired
ig_handlestringrequired
display_namestring, nullablerequired
kind_guessstringrequired
photosnumberrequired
created_atstringrequired
expires_atstringrequired
logo_urlstring, nullablerequired
curl -G "https://www.membber.com/api/v1/admin-previews/intakes" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "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"
    }
  ]
}

Previews: throw an intake away now.

Internal-admin. Deletes the intake and every photo it brought, at once.

Parameters

intakeIdstringpathrequired

Response, 200

discardedbooleanrequired
idstringrequired
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"
Response, 200
{
  "discarded": true,
  "id": "00000d1b-0000-4000-8000-d0c500000000"
}

Previews: one intake, for the review screen.

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).

Parameters

intakeIdstringpathrequired

Response, 200

intakeobjectrequired
11 child fields
idstringrequired
ig_handlestringrequired
display_namestring, nullablerequired
kind_guessstringrequired
kind_matchedarray of stringrequired
is_testbooleanrequired
created_atstringrequired
expires_atstringrequired
preview_idstring, nullablerequired
blockedobjectrequired
3 child fields
codeenumrequired
DO_NOT_CONTACTPREVIEW_EXISTS
added_atstring, nullablerequired
preview_idstring, nullablerequired
photosarray of objectrequired
11 child fields
idstringrequired
roleenumrequired
logoproduct
positionnumberrequired
widthnumberrequired
heightnumberrequired
scorenumberrequired
preselectedbooleanrequired
from_reelbooleanrequired
may_show_peoplebooleanrequired
near_duplicatebooleanrequired
urlstring, nullablerequired
curl -G "https://www.membber.com/api/v1/admin-previews/intakes/21c41567-0000-4000-8000-d0c500000021" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "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"
      }
    ]
  }
}

Previews: make the preview from an intake.

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.

Parameters

intakeIdstringpathrequired

Request body

shop_namestringrequired
kindenumrequired
cookiescakescinnamon-bunspizzatakeawaymeal-prepfish-and-chipscoffeestreetwearbrowniescheesecakesflowerschristmascake-shedsmarket-stallsbutchersfood-vansballoonsparty-eventsother
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
is_testbooleanrequired
logo_photo_idstring · uuid, nullablerequired

Her profile picture as the logo, or null for none.

product_photo_idsarray of string · uuidrequired

The ticked photos, in the order the preview shows them.

itemsarray of objectoptional

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.

12 child fields
namestringrequired
price_penceinteger, nullablerequired
price_from_captionbooleanrequired
photo_idstring · uuid, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstring · urioptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional

Response, 200

previewobjectrequired
41 child fields
idstringrequired
urlstringrequired
short_urlstring, nullableoptional
ig_handlestringrequired
shop_namestringrequired
brand_colorstring, nullableoptional
aboutstring, nullableoptional
areastring, nullableoptional
kindstringrequired
channelenumrequired
cold_dmcomment_replycategory_pagein_personadasked_first
itemsarray of objectrequired
12 child fields
namestringrequired
price_pencenumber, nullablerequired
price_from_captionbooleanrequired
photo_idstring, nullablerequired
descriptionstringoptional
price_sourceenumoptional
captionwebsiteinstagram_mediaset_by_usunknown
source_urlstringoptional
price_kindenumoptional
fixedfrom
price_suffixstringoptional
categorystringoptional
in_dropbooleanoptional
enquirebooleanoptional
is_testbooleanrequired
checkedbooleanoptional
checked_atstring, nullableoptional
review_querystring, nullableoptional
test_querystring, nullableoptional
setup_openbooleanoptional
setup_open_atstring, nullableoptional
interested_atstring, nullableoptional
dm_openerstring, nullableoptional
looked_atobjectoptional
5 child fields
menunumberrequired
itemnumberrequired
dropnumberrequired
more_infonumberrequired
first_to_knownumberrequired
reachedenumoptional
createdmarked_sentopenedlooked_aroundinterestedcontact_givensetup_openedclaimedfirst_drop
interest_contactobjectoptional
3 child fields
kindenumrequired
emailphone
valuestringrequired
given_atstring, nullablerequired
statusenumrequired
draftsentopenedclaimedliveexpired
preview_typeenumrequired
name_onlywith_photos
expires_atstringrequired
expires_in_daysnumber, nullablerequired
created_atstringrequired
updated_atstringrequired
sent_atstring, nullablerequired
followed_up_atstring, nullablerequired
first_opened_atstring, nullablerequired
last_opened_atstring, nullablerequired
open_countnumberrequired
claimed_atstring, nullablerequired
claimed_store_idstring, nullablerequired
ownership_verified_atstring, nullablerequired
ownership_verified_viaenumrequired
dm_codeinstagram
claim_undone_atstring, nullablerequired
photosarray of objectrequired
7 child fields
idstringrequired
roleenumrequired
logoproduct
sortnumberrequired
widthnumber, nullablerequired
heightnumber, nullablerequired
urlstring, nullablerequired
created_atstringrequired
claimobjectrequired
3 child fields
proof_codestring, nullablerequired
storeobjectrequired
5 child fields
idstringrequired
namestring, nullablerequired
drops_linkstring, nullablerequired
went_live_atstring, nullablerequired
is_testbooleanrequired
photos_keptnumberrequired
photos_attachednumberrequired
photos_failednumberrequired
intake_keptbooleanrequired
curl -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"
    ]
  }'
Response, 200
{
  "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
}
WhatsApp
Book a Call
Get Started
Admin previews API | Membber Developers