POST

Bulk 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 multiple items of the same type in one call.

Each entry carries its own field mask and behaves like a single Set Item SEO Tags call. The response reports a result per entry, correlated to the request by itemMetadata.originalIndex, so you can tell exactly which entries succeeded.

A problem with one entry, such as an invalid tag or an item that doesn't exist, fails only that entry. Check bulkActionMetadata.totalFailures and retry just the failed entries: writes are idempotent, so re-sending an entry that already succeeded is safe.

Not every failure is per entry. An item type that isn't supported, or one that doesn't support bulk writes, rejects the whole call, and so does a request that isn't authorized. In those cases there are no per-entry results to inspect, so handle a failed call as well as failed entries.

For static pages, publish: true first saves each valid entry to its draft, then publishes only entries whose draft save succeeded. Successful entries have the same payload submitted to both revisions; no second save request is needed. Concurrent writes can leave revisions different: serialize conflicting item edits. A failed publication entry retains its saved draft and reports itemMetadata.error.data.draftSaved: true. Whole-call publication failures name the acknowledged saved entries in application error data savedItemIds, or in the message of an unexpected system error with publicationStatus: UNKNOWN. Get and List still read the saved revision, not the rendered page head.

entries may contain up to 100 items, but some item types accept fewer per call: a BLOG_POST request is capped at 20 entries. Sending more than an item type's own limit fails the whole call with BULK_CHUNK_SIZE_EXCEEDED, naming the limit; split the request into smaller batches and retry.

Tags can currently be written only for the items' primary language: leave itemSeoTags.language unset on every entry. Sending a language fails with LANGUAGE_NOT_SUPPORTED, even when the entry's field mask doesn't name it.

To set the tags of a single item, call Set Item SEO Tags.

Authentication

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

Permission Scopes
Manage SEO Settings
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/seo-metatags-server/v1/bulk/item-seo-tags/set

Errors
400Invalid Argument

There are 2 errors with this status code.

428Failed Precondition

There are 2 errors with this status code.

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

Did this help?