6 operations. Every schema and example on this page is generated from the platform contract.
Internal-admin. The global switches (and whether the Vercel switch is on) and every shop with a connection or a decision.
Instagram on for shops: screens, connecting, and a precondition of sending.
Automated sending, for every shop.
test_shops, then allow_list (test shops + allowed shops), then everyone.
test_shopsallow_listeveryoneShops with an Instagram connection or a decision, at most 200.
connectedneeds_reconnectdisconnectedConnected, but Instagram has not agreed to send us her messages (webhooks_not_subscribed): nothing can fire.
Her own Pause all.
curl -G "https://www.membber.com/api/v1/admin-instagram-controls" \
-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-instagram-controls");
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.adminInstagramControlsRead().ok.body.json
print(response){
"controls": {
"connect_enabled": true,
"replies_enabled": true,
"audience": "test_shops",
"reason": "Added at the front desk",
"updated_by": "<updated_by>",
"updated_at": "<updated_at>",
"vercel_switch_on": true
},
"shops": [
{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"name": "Example name",
"is_test": true,
"instagram_username": "<instagram_username>",
"connection_status": "connected",
"not_receiving": true,
"paused_by_shop": true,
"allowed": true,
"replies_suspended": true,
"reason": "Added at the front desk",
"updated_at": "<updated_at>"
}
]
}Internal-admin. Takes effect on the next message, no deploy. Audited with the reason.
test_shopsallow_listeveryoneWhy (kept in the audit log and on the control; never shown to a shop).
Instagram on for shops: screens, connecting, and a precondition of sending.
Automated sending, for every shop.
test_shops, then allow_list (test shops + allowed shops), then everyone.
test_shopsallow_listeveryonecurl -X PUT "https://www.membber.com/api/v1/admin-instagram-controls" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"connect_enabled": true,
"replies_enabled": true,
"audience": "test_shops",
"reason": "Added at the front desk"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/admin-instagram-controls", {
body: {
connect_enabled: true,
replies_enabled: true,
audience: "test_shops",
reason: "Added at the front desk"
},
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.adminInstagramControlsSet(
body: .json(.init(
connectEnabled: true,
repliesEnabled: true,
audience: .testShops,
reason: "Added at the front desk"
))
).ok.body.json
print(response){
"controls": {
"connect_enabled": true,
"replies_enabled": true,
"audience": "test_shops",
"reason": "Added at the front desk",
"updated_by": "<updated_by>",
"updated_at": "<updated_at>",
"vercel_switch_on": true
}
}Internal-admin. Suspended, it never sends and the shop cannot switch it back on. Audited.
Why (kept in the audit log and on the control; never shown to a shop).
commentsdmsbothcurl -X PUT "https://www.membber.com/api/v1/admin-instagram-controls/autoreplies/8b1a3916-0000-4000-8000-d0c50000008b" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"suspended": true,
"reason": "Added at the front desk"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/admin-instagram-controls/autoreplies/{autoreplyId}", {
params: { path: { autoreplyId: "8b1a3916-0000-4000-8000-d0c50000008b" } },
body: {
suspended: true,
reason: "Added at the front desk"
},
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.adminInstagramAutoreplySet(
path: .init(autoreplyId: "8b1a3916-0000-4000-8000-d0c50000008b"),
body: .json(.init(
suspended: true,
reason: "Added at the front desk"
))
).ok.body.json
print(response){
"autoreply": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"keywords": [
"<keyword>"
],
"trigger": "comments",
"target_kind": "<target_kind>",
"is_on": true,
"suspended": true,
"suspended_reason": "Added at the front desk",
"made_by": "<made_by>",
"created_at": "<created_at>"
}
}Internal-admin. Any shop, connected or not (to add it to the allow-list).
connectedneeds_reconnectdisconnectedConnected, but Instagram has not agreed to send us her messages (webhooks_not_subscribed): nothing can fire.
Her own Pause all.
commentsdmsbothcurl -G "https://www.membber.com/api/v1/admin-instagram-controls/shops/8fb04ddc-0000-4000-8000-d0c50000008f" \
-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-instagram-controls/shops/{storeId}", {
params: { path: { storeId: "8fb04ddc-0000-4000-8000-d0c50000008f" } },
});
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.adminInstagramShopRead(
path: .init(storeId: "8fb04ddc-0000-4000-8000-d0c50000008f")
).ok.body.json
print(response){
"shop": {
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"name": "Example name",
"is_test": true,
"instagram_username": "<instagram_username>",
"connection_status": "connected",
"not_receiving": true,
"paused_by_shop": true,
"allowed": true,
"replies_suspended": true,
"reason": "Added at the front desk",
"updated_at": "<updated_at>"
},
"autoreplies": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"keywords": [
"<keyword>"
],
"trigger": "comments",
"target_kind": "<target_kind>",
"is_on": true,
"suspended": true,
"suspended_reason": "Added at the front desk",
"made_by": "<made_by>",
"created_at": "<created_at>"
}
]
}Internal-admin. allowed: her place on the auto-replies allow-list. replies_suspended: none of her auto-replies send. Audited.
Why (kept in the audit log and on the control; never shown to a shop).
connectedneeds_reconnectdisconnectedConnected, but Instagram has not agreed to send us her messages (webhooks_not_subscribed): nothing can fire.
Her own Pause all.
curl -X PUT "https://www.membber.com/api/v1/admin-instagram-controls/shops/8fb04ddc-0000-4000-8000-d0c50000008f" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"allowed": true,
"replies_suspended": true,
"reason": "Added at the front desk"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/admin-instagram-controls/shops/{storeId}", {
params: { path: { storeId: "8fb04ddc-0000-4000-8000-d0c50000008f" } },
body: {
allowed: true,
replies_suspended: true,
reason: "Added at the front desk"
},
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.adminInstagramShopSet(
path: .init(storeId: "8fb04ddc-0000-4000-8000-d0c50000008f"),
body: .json(.init(
allowed: true,
repliesSuspended: true,
reason: "Added at the front desk"
))
).ok.body.json
print(response){
"shop": {
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"name": "Example name",
"is_test": true,
"instagram_username": "<instagram_username>",
"connection_status": "connected",
"not_receiving": true,
"paused_by_shop": true,
"allowed": true,
"replies_suspended": true,
"reason": "Added at the front desk",
"updated_at": "<updated_at>"
}
}Internal-admin. Sends real Private Replies through the normal reply code. A comment is only ever answered once. Audited with counts only.
checkedrefusednot_connectednot_set_upInstagram's refusal when reading, as our own short code.
curl -X POST "https://www.membber.com/api/v1/admin-instagram-controls/shops/8fb04ddc-0000-4000-8000-d0c50000008f/check-comments" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-instagram-controls/shops/{storeId}/check-comments", {
params: { path: { storeId: "8fb04ddc-0000-4000-8000-d0c50000008f" } },
body: {},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.adminInstagramCheckComments(
path: .init(storeId: "8fb04ddc-0000-4000-8000-d0c50000008f"),
body: .json(.init())
).ok.body.json
print(response){
"outcome": "checked",
"refused_reason": "Added at the front desk",
"posts_read": -9007199254740991,
"comments_read": -9007199254740991,
"sent": -9007199254740991,
"already_answered": -9007199254740991,
"no_match": -9007199254740991,
"off_for_shop": -9007199254740991,
"failed": -9007199254740991,
"failed_reasons": [
"Added at the front desk"
]
}