Copy Synonyms

Required API Key: any key with the editSettings ACL

Method signature

$client->copySynonyms(string indexNameSrc, string indexNameDest);

client.copy_synonyms(String indexNameSrc, String indexNameDest)

client.copySynonyms(string indexNameSrc, string indexNameDest);

client.copy_synonyms(str indexNameSrc, str indexNameDest)

client.copySynonyms(
  from source: IndexName,
  to destination: IndexName,
  requestOptions: RequestOptions? = nil,
  completion: Result<WaitableWrapper<IndexRevision>> -> Void
)

suspend fun Index.copySynonyms(
    destination IndexName,
    requestOptions: RequestOptions? = null
): RevisionIndex

client.CopySynonyms(string indexNameSrc, string indexNameDest)

client.copySynonyms(string indexNameSrc, string indexNameDest)

client.CopySynonyms(string indexNameSrc, string indexNameDest)

Not implemented yet.

See code examples

About this method

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

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

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

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

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

Read the Algolia CLI documentation for more information.

Copy synonyms

Copy

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

Parameters

`indexNameSrc`	type: string Required Name of the source index to copy.
`indexNameDest`	type: string Required Name of the destination index.

Response

This method doesn't return a response.

Did you find this page helpful?