API Reference / API Methods / Synonyms / Copy synonyms
Required API Key: any key with the editSettings ACL
Method signature
$client->copySynonyms(string indexNameSrc, string indexNameDest);

About this method # A

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

Copy the synonyms of an index to another index on the same app.

Note that this removes all synonyms currently present in the destination index, and replaces them with the synonyms from the source.

Examples # A

Copy synonyms#

1
$client->copySynonyms('indexNameSrc', 'indexNameDest');

Parameters # A

indexNameSrc #
type: string
Required

Name of the source index to copy.

indexNameDest #
type: string
Required

Name of the destination index.

Response # A

This method doesn't return a response.

Did you find this page helpful?
PHP v3