Update Store Portal Link Name
PUT/api/admin/portal/branding/stores/:store/slug
Set the store's portal_slug, the public link name in ?store={portal_slug} sign-in links.
customers:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields:
- portal_slug (optional, string or null): 2–40 lower-case letters, numbers or dashes, not starting or ending with a dash. Trimmed and lower-cased. Must be unique across stores (archived ones included). Omit it or send null to generate one from the store's name if the store has none yet (a collision appends
-2,-3, …).
Changing a slug does not break links already sent: they show the portal default brand instead.
Response: the store's resolved brand, as Get Portal Branding with store_id.
Requires a staff bearer token with the portal.manage permission.
After a change, the previous link name keeps resolving to this store for 90 days, so sign-in links already sent in emails keep showing the store's brand.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.