v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Synonym groups

Delete synonym groups

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: synonyms(w).

Delete all synonyms groups for the provided key. Starts a background task. Returns message.

delete/v1/synonym_groups

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
sectionstring

The section of the index to use. Defaults to Products.

Example:Products
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Response

OK

messagestring required

Example response

{
  "message": "Successfully deleted all synonyms"
}