2026.6.3
Home ▸ Actions

Add password

The Add password action adds a password to a SwitchBot Keypad Vision device. After you add it, the password can be used to unlock the linked device on the keypad.

The password must be 6 to 12 digits long.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To add a password from an automation or a script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create to start a new one.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger.
  4. In the Then do section, select Add action.
  5. From the search box, search for and select SwitchBot: Add password.
  6. Select the Device and enter the Password.
  7. Select Save.

Options in the UI

Device (Required)

The Keypad Vision device to add the password to.
Password (Required)

A 6 to 12 digit password.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as switchbot.add_password. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more] 
action: switchbot.add_password
data:
  device_id: c2d01328efd261f586e56d914e3af07e
  password: "123456"

This adds the password 123456 to the selected Keypad Vision device.

Options in YAML

device_id string Required

The device ID of the Keypad Vision device to add the password to.

password string Required

A 6 to 12 digit password.

Good to know

  • This action is available on SwitchBot Keypad Vision devices.
  • The password must be 6 to 12 digits long.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.