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

# Update User Tag

> Update the SSO tag for an existing user.

## Overview

Updates the SSO tag for an existing user. `epUserId` identifies the user whose tag
should change, and `tag` specifies the new value. Call [Verify Tag](https://docs.bvndle.com/bvndle-sso/verify-tag.md)
first to confirm the new tag is available.

> [!NOTE]
>
> A user tag can only be updated once in 30 days.

## Endpoint Details

| Property | Value |
| - | - |
| Method | `PUT` |
| URL | `https://test-api.bvndle.com/api/v1/ufel/users/update-tag` |
| Base URL | `https://test-api.bvndle.com/api/v1/ufel` |
| Authentication | None |

## Request Headers

| Header | Value |
| - | - |
| `Content-Type` | `application/json` |

## Request Body

Send the request body as JSON. All four fields are required.

| Field | Type | Required | Description |
| - | - | - | - |
| `clientId` | string | Yes | The SSO partner's client ID. |
| `partnerId` | UUID | Yes | The LaaS partner ID, distinct from the SSO `clientId`. |
| `tag` | string | Yes | The new tag to assign to the user. |
| `epUserId` | UUID | Yes | The enterprise partner user ID identifying the user whose tag will be updated. |

### Example Request Body

```json theme={null}
{
  "clientId": "YOUR_SSO_CLIENT_ID",
  "partnerId": "eacad691-85c5-4b52-a311-345e23ac6b99",
  "tag": "iheonu21",
  "epUserId": "3f3a51e9-492b-4270-a530-e4d1169dd6a7"
}
```

```bash cURL theme={null}
curl --request PUT \
  'https://test-api.bvndle.com/api/v1/ufel/users/update-tag' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientId": "YOUR_SSO_CLIENT_ID",
    "partnerId": "eacad691-85c5-4b52-a311-345e23ac6b99",
    "tag": "iheonu21",
    "epUserId": "3f3a51e9-492b-4270-a530-e4d1169dd6a7"
  }'
```

## Response Structure

| Field | Type | Description |
| - | - | - |
| `status` | string | Response status, such as `success`. |
| `message` | string | Human-readable result message. |
| `data` | object | Details of the updated user tag. Some success responses return an empty object. |
| `data.tag` | string | The new tag value, when returned. |
| `data.epUserId` | string | The user's enterprise partner user ID, when returned. |

```json Success (200 OK) theme={null}
{
  "status": "success",
  "message": "User tag updated successfully",
  "data": {
    "tag": "iheonu21",
    "epUserId": "3f3a51e9-492b-4270-a530-e4d1169dd6a7"
  }
}
```

```json Tag Already Taken (409 Conflict) theme={null}
{
  "status": "error",
  "message": "Tag 'iheonu21' is already in use"
}
```

## Notes

* Check availability using [Verify Tag](https://docs.bvndle.com/bvndle-sso/verify-tag.md) (`GET /api/v1/ufel/users/verify-tag?tag=iheonu21`) before updating.
* Use the LaaS `partnerId` and the SSO `clientId` in their respective fields.
* `epUserId` must identify an existing user. Updating a nonexistent user results in an error.
* After a successful update, the user must use their new tag for subsequent SSO login attempts.
* This `PUT` replaces the old tag entirely.
* A tag can only be updated once in 30 days.


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