Update Store | ListBee

Update store brand info: display_name, bio, avatar (file token from POST /v1/files), slug. Response includes readiness status — check actions for what’s needed before selling.

Authentication

AuthorizationBearer

API key (lb_ prefix). Pass as: Authorization: Bearer lb_...

Request

This endpoint expects an object.

display_namestring or nullOptional

Store display name shown to buyers

biostring or nullOptional

Store bio shown on product pages

avatarstring or nullOptional

File token from POST /v1/files with purpose=avatar. Upload an image first, then pass the file token here. Set to empty string to remove the avatar.

slugstring or nullOptionalformat: "^[a-z0-9][a-z0-9-]*[a-z0-9]$"3-60 characters

URL-safe store slug used in checkout URLs. Must be 3-60 characters, start and end with alphanumeric, contain only lowercase letters, digits, and hyphens.

Response

Successful Response

idstring

Unique store ID (st_ prefixed).

display_namestring

Store display name shown to buyers.

slugstring

URL-safe store slug used in checkout URLs.

urlstring

Public store URL.

readinessobject

Store readiness. Check actions for what’s needed before you can sell.

object"store"

Object type identifier. Always store.

biostring or null

Store bio shown on product pages.

has_avatarbooleanDefaults to false

True if an avatar image has been uploaded.

api_keystring or null

Raw API key, shown once at creation. Use as Bearer token.

Errors

422

Unprocessable Entity Error

1	import requests
2
3	url = "https://api.listbee.so/v1/store"
4
5	payload = {
6	"display_name": "Acme Agency",
7	"bio": "We make great things.",
8	"avatar": "file_7kQ2xY9mN3pR5tW1vB8a01",
9	"slug": "acme-agency"
10	}
11	headers = {
12	"Authorization": "Bearer <token>",
13	"Content-Type": "application/json"
14	}
15
16	response = requests.put(url, json=payload, headers=headers)
17
18	print(response.json())

1	{
2	"id": "st_7kQ2xY9mN3pR5tW1vB8a",
3	"display_name": "Acme Agency",
4	"slug": "acme-agency",
5	"url": "https://buy.listbee.so/acme-agency",
6	"readiness": {
7	"sellable": false,
8	"actions": [
9	{
10	"code": "connect_stripe",
11	"kind": "api",
12	"priority": "required",
13	"message": "Set Stripe secret key to accept payments",
14	"resolve": {
15	"method": "POST",
16	"endpoint": "/v1/account/stripe-key",
17	"url": "https://console.listbee.so/connect/stripe",
18	"params": {
19	"secret_key": "sk_live_..."
20	}
21	}
22	}
23	],
24	"next": "connect_stripe"
25	},
26	"object": "store",
27	"bio": "We make great things.",
28	"has_avatar": false,
29	"api_key": "lb_abc123"
30	}