> ## Documentation Index
> Fetch the complete documentation index at: https://ona.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Preference

> Sets a user preference value.

`Unary` · [`Users`](https://ona.com/docs/api-reference/generated/user/overview)

Sets a user preference value.

Use this method to:

* Store user settings
* Update preferences
* Configure user experience

### Examples

* Set preference:

  Updates a user preference setting.

  ```yaml theme={null}
  key: "theme"
  value: "dark"
  ```

## Endpoint

```text theme={null}
POST /api/gitpod.v1.UserService/SetPreference
```

Send a Bearer token as described in [Authentication](https://ona.com/docs/api-reference.md#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.

## Request example

```bash cURL theme={null}
export ONA_HOST=https://app.ona.com
export ONA_API_KEY=<your-token>

curl --request POST \
  --url "$ONA_HOST/api/gitpod.v1.UserService/SetPreference" \
  --header "Authorization: Bearer $ONA_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "key": "<key>"
}'
```

```python Python theme={null}
import gitpod.v1.user_pb2 as user_pb2
from ona_sdk import create_client_from_env

ona = create_client_from_env()
request = user_pb2.SetPreferenceRequest(
    key="<key>",
)
response = ona.services.user.set_preference(request)
print(response)
```

```typescript TypeScript theme={null}
import { create } from "@bufbuild/protobuf";
import { createClientFromEnv } from "@gitpod/sdk";
import { SetPreferenceRequestSchema } from "@gitpod/sdk/gitpod/v1/user_pb";

async function main() {
  const ona = createClientFromEnv();
  const request = create(SetPreferenceRequestSchema, {
    key: "<key>",
  });
  const response = await ona.services.user.setPreference(request);
  console.log(response);
}

main().catch(console.error);
```

```go Go theme={null}
package main

import (
	"context"
	"fmt"
	"log"

	"connectrpc.com/connect"
	"github.com/gitpod-io/gitpod-sdk-go/sdk"
	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
)

func main() {
	ona, err := sdk.NewFromEnv()
	if err != nil {
		log.Fatal(err)
	}

	request := connect.NewRequest(&gitpodpb.SetPreferenceRequest{
		Key: "<key>",
	})
	response, err := ona.Services.User.SetPreference(context.Background(), request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response.Msg)
}
```

```json Request body theme={null}
{
  "key": "<key>"
}
```

## Request

`gitpod.v1.SetPreferenceRequest`

| Field | Type | Required | Description |
| - | - | - | - |
| `key` | string | No | Constraints: `string.max_len=255, string.min_len=1`. |
| `value` | string | No | omitting value field will cause an error due to min\_len validation, to unset a preference use DeletePreference instead Constraints: `string.max_len=10240, string.min_len=1`. |

## Response

`gitpod.v1.SetPreferenceResponse`

This message has no fields.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.