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

# Attention: Update User

> Change an Attention user's name, teams, role or deals access. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Change an Attention user's name, teams, role or deals access.

> [!NOTE]
>
> Tool ID: `attention_update_user`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'attention_update_user',
  {
    "userId": "user_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute attention_update_user --input '{
  "userId": "user_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": {
      "uuid": "uuid_123",
      "email": "jane.doe@example.com",
      "firstName": "Jane"
    }
  }
}
```

Use `deepline describe attention_update_user --json` for the latest machine-readable contract.

## Input reference

Updates an existing user's information in the organization. You can modify the user's name, email, team assignment, and role. Requires proper permissions to update user details.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.userId` | `string` | Yes | — | UUID of the user to update |
| `payload.firstName` | `string` | No | — | — |
| `payload.lastName` | `string` | No | — | — |
| `payload.password` | `string` | No | — | — |
| `payload.botName` | `string` | No | — | — |
| `payload.dealsEnabled` | `boolean` | No | — | — |
| `payload.teamUUIDsToRemove` | `array` | No | — | — |
| `payload.teamsToAdd` | `array` | No | — | — |
| `payload.roleUUID` | `string` | No | — | The UUID of the role assigned to the user. |
| `payload.seat_type` | `"listener" \| "recording"` | No | `"recording"` | The type of seat assigned to the user. Allowed: `listener`, `recording`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Updates an existing user's information in the organization. You can modify the user's name, email, team assignment, and role. Requires proper permissions to update user details.",
    "properties": {
      "userId": {
        "type": "string",
        "description": "UUID of the user to update"
      },
      "firstName": {
        "type": "string"
      },
      "lastName": {
        "type": "string"
      },
      "password": {
        "type": "string"
      },
      "botName": {
        "type": "string"
      },
      "dealsEnabled": {
        "type": "boolean"
      },
      "teamUUIDsToRemove": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "teamsToAdd": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "uuid": {
              "type": "string",
              "description": "The UUID of the team the user will belong to."
            },
            "primary": {
              "type": "boolean",
              "description": "Whether this team is the user's primary team."
            }
          },
          "required": [
            "uuid"
          ],
          "additionalProperties": false
        }
      },
      "roleUUID": {
        "type": "string",
        "description": "The UUID of the role assigned to the user."
      },
      "seat_type": {
        "type": "string",
        "description": "The type of seat assigned to the user.",
        "default": "recording",
        "enum": [
          "listener",
          "recording"
        ]
      }
    },
    "required": [
      "userId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.uuid` | `string` | No | — | The unique identifier of the user. |
| `result.data.data.email` | `string` | No | — | The email address of the user. |
| `result.data.data.firstName` | `string` | No | — | The first name of the user. |
| `result.data.data.lastName` | `string` | No | — | The last name of the user. |
| `result.data.data.createdAt` | `string` | No | — | The date and time the user was created. |
| `result.data.data.deletedAt` | `string` | No | — | The date and time the user was deactivated. |
| `result.data.data.transcriptLang` | `string` | No | — | The preferred transcript language for the user. |
| `result.data.data.joinOutsideHostMeetings` | `boolean` | No | — | Indicates if the user can join meetings outside their host organization. |
| `result.data.data.realTimeCapabilities` | `boolean` | No | — | Indicates if the user has real-time transcription capabilities. |
| `result.data.data.settings` | `object` | No | — | — |
| `result.data.data.settings.realTimeCapabilitiesOFF` | `boolean` | No | — | — |
| `result.data.data.settings.autoCalculateCRMFields` | `boolean` | No | — | — |
| `result.data.data.settings.joinWhenIAmHostAndAlone` | `boolean` | No | — | — |
| `result.data.data.settings.joinWhenIAmHostWithPeers` | `boolean` | No | — | — |
| `result.data.data.settings.joinWhenPeerIsHost` | `boolean` | No | — | — |
| `result.data.data.settings.joinWhenUnlicensedPeerIsHost` | `boolean` | No | — | — |
| `result.data.data.settings.dealsEnabled` | `boolean` | No | — | — |
| `result.data.data.botName` | `string` | No | — | The name of the bot associated with the user. |
| `result.data.data.botImageURL` | `string` | No | — | The URL of the bot's profile image. |
| `result.data.data.primaryTeamUUID` | `string` | No | — | The UUID of the user's primary team. |
| `result.data.data.organizationRoleUUID` | `string` | No | — | The UUID of the user's role in the organization. |
| `result.data.data.roles` | `array` | No | — | A list of roles assigned to the user. |
| `result.data.data.roles[].uuid` | `string` | No | — | — |
| `result.data.data.roles[].name` | `string` | No | — | — |
| `result.data.data.roles[].type` | `string` | No | — | — |
| `result.data.data.showReferralScreen` | `boolean` | No | — | Whether the user is shown a referral screen. |
| `result.data.data.seatType` | `string` | No | — | The type of seat assigned to the user. |
| `result.data.data.teams` | `array` | No | — | A list of teams assigned to the user. |
| `result.data.data.teams[].uuid` | `string` | No | — | Unique identifier of the team |
| `result.data.data.teams[].name` | `string` | No | — | Name of the team |
| `result.data.data.teams[].phrases` | `array` | No | — | List of keywords or phrases associated with the team |
| `result.data.data.teams[].slackConnection` | `object` | No | — | Represents the Slack integration details for a team |
| `result.data.data.teams[].slackConnection.id` | `string` | No | — | Slack connection identifier |
| `result.data.data.teams[].slackConnection.info` | `object` | No | — | Information about a connected Slack team |
| `result.data.data.teams[].slackConnection.info.id` | `string` | No | — | Slack team identifier |
| `result.data.data.teams[].slackConnection.info.name` | `string` | No | — | Name of the Slack team |
| `result.data.data.teams[].domain` | `string` | No | — | Domain associated with the team |
| `result.data.data.teams[].organizerJoinInternalMeetings` | `boolean` | No | — | Whether team organizers can join internal meetings |
| `result.data.data.teams[].consentEmailEnabled` | `boolean` | No | — | Whether email consent is enabled for the team |
| `result.data.data.teams[].parentTeamUUID` | `string` | No | — | UUID of the parent team if this team is part of a hierarchy |
| `result.data.data.teams[].organizationUUID` | `string` | No | — | UUID of the organization this team belongs to |
| `result.data.data.teams[].children` | `array` | No | — | List of child teams if this team has a hierarchical structure |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "uuid": {
                "type": "string",
                "description": "The unique identifier of the user."
              },
              "email": {
                "type": "string",
                "description": "The email address of the user."
              },
              "firstName": {
                "type": "string",
                "description": "The first name of the user."
              },
              "lastName": {
                "type": "string",
                "description": "The last name of the user."
              },
              "createdAt": {
                "type": "string",
                "description": "The date and time the user was created."
              },
              "deletedAt": {
                "type": "string",
                "description": "The date and time the user was deactivated."
              },
              "transcriptLang": {
                "type": "string",
                "description": "The preferred transcript language for the user."
              },
              "joinOutsideHostMeetings": {
                "type": "boolean",
                "description": "Indicates if the user can join meetings outside their host organization."
              },
              "realTimeCapabilities": {
                "type": "boolean",
                "description": "Indicates if the user has real-time transcription capabilities."
              },
              "settings": {
                "type": "object",
                "properties": {
                  "realTimeCapabilitiesOFF": {
                    "type": "boolean"
                  },
                  "autoCalculateCRMFields": {
                    "type": "boolean"
                  },
                  "joinWhenIAmHostAndAlone": {
                    "type": "boolean"
                  },
                  "joinWhenIAmHostWithPeers": {
                    "type": "boolean"
                  },
                  "joinWhenPeerIsHost": {
                    "type": "boolean"
                  },
                  "joinWhenUnlicensedPeerIsHost": {
                    "type": "boolean"
                  },
                  "dealsEnabled": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": false
              },
              "botName": {
                "type": "string",
                "description": "The name of the bot associated with the user."
              },
              "botImageURL": {
                "type": "string",
                "description": "The URL of the bot's profile image."
              },
              "primaryTeamUUID": {
                "type": "string",
                "description": "The UUID of the user's primary team."
              },
              "organizationRoleUUID": {
                "type": "string",
                "description": "The UUID of the user's role in the organization."
              },
              "roles": {
                "type": "array",
                "description": "A list of roles assigned to the user.",
                "items": {
                  "type": "object",
                  "properties": {
                    "uuid": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "showReferralScreen": {
                "type": "boolean",
                "description": "Whether the user is shown a referral screen."
              },
              "seatType": {
                "type": "string",
                "description": "The type of seat assigned to the user."
              },
              "teams": {
                "type": "array",
                "description": "A list of teams assigned to the user.",
                "items": {
                  "type": "object",
                  "description": "Represents a team in the system with its properties and hierarchical structure",
                  "properties": {
                    "uuid": {
                      "type": "string",
                      "description": "Unique identifier of the team"
                    },
                    "name": {
                      "type": "string",
                      "description": "Name of the team"
                    },
                    "phrases": {
                      "type": "array",
                      "description": "List of keywords or phrases associated with the team",
                      "items": {
                        "type": "string"
                      }
                    },
                    "slackConnection": {
                      "type": "object",
                      "description": "Represents the Slack integration details for a team",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Slack connection identifier"
                        },
                        "info": {
                          "type": "object",
                          "description": "Information about a connected Slack team",
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Slack team identifier"
                            },
                            "name": {
                              "type": "string",
                              "description": "Name of the Slack team"
                            }
                          },
                          "additionalProperties": false
                        }
                      },
                      "additionalProperties": false
                    },
                    "domain": {
                      "type": "string",
                      "description": "Domain associated with the team"
                    },
                    "organizerJoinInternalMeetings": {
                      "type": "boolean",
                      "description": "Whether team organizers can join internal meetings"
                    },
                    "consentEmailEnabled": {
                      "type": "boolean",
                      "description": "Whether email consent is enabled for the team"
                    },
                    "parentTeamUUID": {
                      "type": "string",
                      "description": "UUID of the parent team if this team is part of a hierarchy"
                    },
                    "organizationUUID": {
                      "type": "string",
                      "description": "UUID of the organization this team belongs to"
                    },
                    "children": {
                      "type": "array",
                      "description": "List of child teams if this team has a hierarchical structure",
                      "items": {
                        "type": "object",
                        "description": "Recursive OpenAPI schema reference #/components/schemas/Team.",
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Attention provider guide](https://deepline.com/docs/providers/attention/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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