Set a lock user code

Use this action to store a user code in a slot on a Zigbee lock. This lets you set or change a PIN code from an automation or a script, for example to hand out a temporary code to a guest and change it after they leave.

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 set a lock user code from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the lock you want to set a code on.
6. From the actions shown for that target, select Set lock user code.
7. Set the code slot and the code.
8. Select Save.

Options in the UI

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 zha.set_lock_user_code. A basic example looks like this:

action: zha.set_lock_user_code
target:
  entity_id: lock.front_door
data:
  code_slot: 1
  user_code: "1234"

Options in YAML

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single entityAn 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], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching lock entity behind that target.

• Entity: one specific lock entity, such as lock.living_room.
• Device: every lock entity that belongs to a device.
• Area: every lock entity in a room or area.
• Floor: every lock entity on a floor.
• Label: every lock entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

• The number of available slots and the allowed code length depend on the lock. For example, a Kwikset 954 supports slots 1 to 32 and codes of 4 to 8 digits.
• Setting a code in a slot that already has one overwrites the existing code.

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.

Related actions

These actions work well alongside this one:

• Enable a lock user code: Enables a user code in a slot on a Zigbee lock.

• Disable a lock user code: Disables a user code in a slot on a Zigbee lock.

• Clear a lock user code: Removes a user code from a slot on a Zigbee lock.