PATCH

Set Item Seo Tags


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sets the SEO tags of a single item.

List the fields to change in fieldMask.

Setting tags replaces the item's tags in full, so send the complete set you want the item to have. To return the item to the tags it inherits, call Reset Item SEO Tags To Default rather than sending an empty list.

Whether the change reaches the live site immediately depends on the item type. Items that keep no separate draft, such as store products, are always live. Static pages keep a draft and a published version, so set publish to true to update the published one. A blog post that's already published stays published. Setting publish for an item type that keeps no draft has no effect.

For a static page, publish: true updates only the published revision — it does not also update the saved one. Get Item SEO Tags and List Item SEO Tags always read the saved revision, so they keep returning the values from before this call until the same changed fields are also set without publish. This method's own response isn't a read of the published revision either, so don't treat it as confirmation that the live page changed — check the live page to confirm that.

Tags are validated before anything is saved, so a request that contains an invalid tag changes nothing.

To set the tags of many items in one call, call Bulk Set Item SEO Tags.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage SEO Settings
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/seo-metatags-server/v1/item-seo-tags/{itemType}/{itemId}

Errors
400Invalid Argument

There are 3 errors with this status code.

404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?