Patch Store Facebook / Meta Catalog Settings (v1)
Method & Path
PATCH /api/v1/workspace/:workspaceId/storefront/store/facebook-catalog
Actual backend path: PATCH /v1/workspace/:workspaceId/storefront/store/facebook-catalog
Description
Updates Meta Catalog feed and Pixel settings for the workspace storefront. Workspace Owners (and Staff with store.manage) can paste the full Meta Pixel base code; the API stores only the numeric Pixel ID. When feedEnabled is set to true and no feed token exists yet, the API generates a token, stores only its hash, and may return plainFeedToken once in the response for copying the full feed URL.
Authentication
Required — JWT workspace token and staff context.
Required Permissions: store.manage
Personas: Workspace Owner and Staff with store.manage.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <token> |
Content-Type | Yes | application/json |
X-Staff-Id | If applicable | Staff member performing the action |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | Workspace id |
Query Parameters
None
Request Body
At least one field required.
{
"feedEnabled": true,
"brandOverride": "My Brand",
"pixelId": "123456789012345",
"pixelEnabled": true
}
| Field | Type | Required | Description |
|---|---|---|---|
feedEnabled | boolean | No | Enable/disable public CSV feed |
brandOverride | string | null | No | Catalog brand field; null clears override (store name used) |
pixelId | string | null | No | Meta Pixel id (digits) or the full Events Manager base-code snippet. The API extracts the numeric id and never stores raw HTML. Null or empty clears. |
pixelEnabled | boolean | No | When true with a valid pixelId, the public store JSON includes facebookPixelId and the storefront injects the official pixel snippet into <head> |
Response 200 OK
{
"store": { },
"plainFeedToken": "optional-one-time-secret"
}
plainFeedToken is present only when a new token was generated (e.g. first enable).
Common Errors
- 400 Bad Request: Empty body, validation error, or pasted pixel code without a valid Pixel ID
- 401 Unauthorized: Missing/invalid token
- 403 Forbidden: Missing
store.manage - 404 Not Found: Store not created
- 500 Internal Server Error: Server error