# Update the signed-in user's profile

Writes the given profile fields, records a user activity entry and returns the updated user with the organization's private attributes left out.

`PATCH /api/v1/public/profile`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Writes the given profile fields, records a user activity entry and returns the updated user with the organization's private attributes left out. Answers 403 when `defaultWorkspaceId` names a workspace the caller is not a member of; on success a new default workspace also applies to the current session.

## Request

Send the body as `application/json`. The body is optional.

| Field                | Type                 | Required | Constraints                             | Description |
| -------------------- | -------------------- | -------- | --------------------------------------- | ----------- |
| `name`               | string               | No       | 2 to 200 characters                     | -           |
| `country`            | string               | No       | at most 100 characters                  | -           |
| `language`           | string               | No       | at most 64 characters                   | -           |
| `currency`           | string               | No       | at most 16 characters                   | -           |
| `timezone`           | string               | No       | at most 64 characters                   | -           |
| `defaultWorkspaceId` | one of: string, null | No       | -                                       | -           |
| `image`              | string               | No       | an image URL of at most 2048 characters | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X PATCH "https://api.console.buildbase.app/api/v1/public/profile" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "country": "string",
  "language": "string"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/profile',
  {
    method: 'PATCH',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      country: 'string',
      language: 'string',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.patch(
    "https://api.console.buildbase.app/api/v1/public/profile",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "country": "string",
        "language": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "_id": "000000000000000000000001",
  "attributes": {},
  "blocked": false,
  "blockedReason": "",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "credentialsChangedAt": null,
  "currency": "",
  "deleted": false,
  "email": "user@example.com",
  "emailVerified": true,
  "firstAuthAt": "2026-01-01T00:00:00.000Z",
  "id": "000000000000000000000001",
  "image": "http://localhost:4443/buildbase-local-assets/orgs/000000000000000000000002/assets/file-000000000000000000000003.png",
  "isAgent": false,
  "kind": "human",
  "language": "",
  "name": "Session User uploads-1767225600000",
  "orgMembershipId": "",
  "role": "user",
  "stripeId": "",
  "systemTags": [],
  "tags": [],
  "timezone": "",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "workflowsDisabled": false
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Events

A successful call can send these [webhook events](/webhooks/overview) to the endpoints that subscribe to them:

- [`user.profile_updated`](/webhooks/overview#when-each-event-fires)

## Related

- [Profile guide](/users/overview): how this part of BuildBase works
- [All Profile operations](/http-api/reference/profile)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `profile.update` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
