Update Multiple Linked Access Codes

• Request Parameters

• Response

• Examples

Updates access codes that share a common code across multiple devices.

Specify the common_code_key to identify the set of access codes that you want to update.

See also Update Linked Access Codes.

Signature

PATCH /access_codes/update_multiple ⇒ void

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

common_code_key String (Required)

Key that links the group of access codes, assigned on creation by /access_codes/create_multiple.

---

ends_at String

Date and time at which the validity of the new access code ends, in ISO 8601 format. Must be a time in the future and after starts_at.

---

name String

Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.

  Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
  
  To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
  
  To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).

---

starts_at String

Date and time at which the validity of the new access code starts, in ISO 8601 format.

---

Response

void