# Update a legal profile

> Available starting with the **sign 26.1300.0** module. On older self-hosted installations the method may be unavailable: the platform returns `422 METHOD_NOT_YET_AVAILABLE` with `error.release`.

`PATCH /v1/sign-b2e/legal-profiles/:userId`

Writes the legal fields of an active employee or a user without a department in a single transaction. Requires permission to edit legal data; the response contains the codes of the changed fields without their values.

**Scopes:** `sign.b2e`, `user`.

## Path parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| `userId` | string | yes | User ID from the [list of users](/docs/entities/users). |

## Request body fields

| Parameter | Type | Required | Description |
|---|---|---|---|
| `fields` | object | yes | Fields object. Bitrix24 validates unknown fields and value requirements. |

## Examples

### curl — personal key

```bash
curl -X PATCH 'https://vibecode.bitrix24.com/v1/sign-b2e/legal-profiles/7' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}}'
```

### curl — OAuth application

```bash
curl -X PATCH 'https://vibecode.bitrix24.com/v1/sign-b2e/legal-profiles/7' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}}'
```

### JavaScript — personal key

```javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/legal-profiles/7', {
  "method": "PATCH",
  "headers": {
    "X-Api-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
```

### JavaScript — OAuth application

```javascript
const response = await fetch('https://vibecode.bitrix24.com/v1/sign-b2e/legal-profiles/7', {
  "method": "PATCH",
  "headers": {
    "X-Api-Key": "YOUR_APP_KEY",
    "Authorization": "Bearer USER_SESSION_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"fields": {"UF_LEGAL_ADDRESS": "VIBE-PROBE Sample Street 10"}})
});
const result = await response.json();
if (!response.ok || !result.success) throw new Error(result.error?.message);
console.log(result.data);
```

## Response fields

| Field | Type | Description |
|---|---|---|
| `success` | boolean | Whether the request succeeded. |
| `data` | object | Operation data. |
| `data.userId` | integer | User ID. |
| `data.updated` | array<string> | Codes of the changed fields, or the provider update result. |
| `meta.redacted` | array<string> | Present when credentials are hidden; contains the paths of the replaced values. |

## Response example

Shape of a successful response; the data depends on the Bitrix24 account and the request.

```json
{
  "success": true,
  "data": {
    "userId": 7,
    "updated": [
      "UF_LEGAL_ADDRESS"
    ]
  }
}
```

## Error response example

403 — the key lacks a required scope:

```json
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'sign.b2e' scope"
  }
}
```

## Errors

| HTTP | Code | Reason |
|---|---|---|
| 400 | `INVALID_PARAMS` | Invalid request shape: types, required fields or an unknown query string parameter. |
| 401 | `TOKEN_MISSING` | No credentials for the Bitrix24 connection. |
| 403 | `SCOPE_DENIED` | One of the required scopes is not granted. |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the operation; the code is in error.b24Code, the text in error.message. |
| 403 | `WRITE_BLOCKED_READONLY_KEY` | The key is read-only. |
| 422 | `METHOD_NOT_YET_AVAILABLE` | The method is not yet available on the Bitrix24 account; the release is in error.release. |

[Common API errors](/docs/errors).

## Known specifics

Bitrix24 checks user permissions, HR e-signature availability, business rules, page sizes and field contents. Values are passed through without local correction. Response text is JSON-encoded; credential-bearing links are hidden.

The operation is not retried automatically. If the outcome is unknown, check the state in the Bitrix24 account first; repeating the call can repeat the operation.

From 1 to 50 codes from the [list of legal fields](./list-legal-fields.md) are accepted; the value format depends on the field's type and options. An address cannot contain the `|` character. Either all fields are written or none.

## See also

- [Employee signatures](/docs/sign-b2e)
- [API errors](/docs/errors)
