<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@workgrid/client](./client.md) &gt; [Client](./client.client.md) &gt; [customMutate](./client.client.custommutate.md)

## Client.customMutate() method

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
> 

Invoke a custom mutation (should be used sparingly and never in production)

<b>Signature:</b>

```typescript
customMutate<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: CustomMutationKey, variables?: TVariables, options?: MutationOptions<TData, TError, TVariables, TContext>): Promise<TData>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  mutationKey | CustomMutationKey | A unique cache key |
|  variables | TVariables | The appropriate variables |
|  options | MutationOptions&lt;TData, TError, TVariables, TContext&gt; | Any additional mutation options |

<b>Returns:</b>

Promise&lt;TData&gt;

The mutation result

