API referencePage publish
Publish
Authorization
apiKey AuthorizationBearer <token>
Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
workspaceId*string
surfaceId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/workspaces/string/surfaces/string/publish" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "enabled": true, "slug": "string", "seoIndexed": true, "coverImageUrl": "string", "showIcon": true, "theme": { "background": { "type": "none", "color": "string", "gradient": "string", "gradientFrom": "string", "gradientTo": "string", "gradientAngle": 0, "imageUrl": "string", "blur": 0 }, "accent": "string", "radius": 0, "pageWidth": "default", "colorScheme": "auto" }, "publishedAt": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}