Skip to main content

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.

Required scope: customers:write

Grant 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​

OK

Response Headers
    Content-Type