LogoLogo
Sign UpSupported Devices
  • Seam Documentation
  • 🚲Quick Start
  • 🚀Go Live!
  • Contact Us
  • Core Concepts
    • Overview
    • Seam Console
      • Seam Online CLI
    • Workspaces
    • Authentication
      • API Keys
      • Personal Access Tokens
      • Client Sessions and Client Session Tokens
        • Implementing Client Sessions for Device Management in the Backend
    • Devices
      • Displaying Device Health
      • Displaying Device Power Status
      • Managed and Unmanaged Devices
      • Adding Custom Metadata to a Device
      • Filtering Devices by Custom Metadata
      • Testing Your App Against Device Disconnection and Removal
    • Connected Accounts
      • Adding Custom Metadata to a Connected Account
      • Filtering Connected Accounts by Custom Metadata
      • Reconnecting an Account
    • Action Attempts
  • Capability Guides
    • 📋Device and System Capabilities
    • 🔒Smart Locks
      • Locking and Unlocking Smart Locks
      • Creating and Managing Smart Lock Access Codes
        • Creating Access Codes
        • Retrieving Access Codes
        • Modifying Access Codes
        • Deleting Access Codes
        • Lifecycle of Access Codes
        • Access Code Requirements for Door Locks
        • Streamlining Access Code Management from the Manufacturer App
        • Troubleshooting Access Codes
        • Managing Backup Access Codes
        • Managing Offline Access Codes
        • Creating and Updating Multiple Linked Access Codes
        • Migrating Existing Unmanaged Access Codes
    • 🏢Access Control Systems
      • ACS Quick Starts
        • PIN Code Quick Start
        • Encodable Key Card Quick Start
        • Mobile Key Quick Start
      • Connect an ACS to Seam
        • Retrieving ACS System Details
        • Access Control System Resources
        • Understanding Access Control System Differences
      • Managing ACS Users
        • Suspending and Unsuspending ACS Users
        • Assigning ACS Users to Access Groups
      • Retrieving Entrance Details
      • Managing Credentials
        • Assigning Credentials to ACS Users
        • Listing Credentials and Associated Entrances
      • Working with Card Encoders and Scanners
        • Creating and Encoding Card-based Credentials
        • Scanning Encoded Cards
      • Troubleshooting Your Access Control System
    • 📱Mobile Access
      • Prepare your Workspace
      • Managing Mobile App User Accounts with User Identities
      • Managing Phones for a User Identity
      • Issuing Mobile Credentials from an Access Control System
      • Developing in a Sandbox Workspace
      • Integrating into your Mobile Application
        • Initializing the Seam Mobile SDK
        • Handling System Permissions
        • Using Unlock With Tap
    • 🌡️Thermostats
      • Understanding Thermostat Concepts
        • HVAC Mode
        • Set Points
      • Retrieving Thermostats
      • Setting and Monitoring Temperature Thresholds
      • Setting the Current HVAC and Fan Mode Settings
      • Creating and Managing Climate Presets
        • Setting the Fallback Climate Preset
        • Activating a Climate Preset
      • Creating and Managing Thermostat Schedules
      • Testing Your Thermostat App with Simulate Endpoints
    • 👂Noise Sensors
      • Configuring Noise Threshold Settings
    • 📡Seam Bridge
  • 💻UI Components
    • 🔌Connect Webviews
      • Connect Webview Process
      • Embedding a Connect Webview in Your App
      • Verifying Successful Account Connection
      • Retrieving Devices or Access Control Systems Connected Through a Connect Webview
      • Attaching Custom Metadata to the Connect Webview
      • Filtering Connect Webviews by Custom Metadata
      • Customizing Connect Webviews
    • 🧱Seam Components
      • Getting Started with Seam Components
        • Get Started with React
        • Get started with Angular
        • Get started with Vue
        • Get started with Client Side Components
      • Components
        • Device Details
        • Device Table
        • Access Code Table
        • Access Code Details
        • Create Access Code Form
        • Update Access Code Form
        • Supported Devices Table
        • Seam Provider
        • Connect Account Button
      • Make a Supported Devices Page
      • Using User Identities to Scope Users' Device Access
  • 📋API Reference
    • Overview
    • Installation
    • Authentication
    • Workspaces
      • Get Workspace
      • Reset Workspace
    • Client Sessions
      • Create a Client Session
      • Get or Create a Client Session
      • List Client Sessions
      • Get a Client Session
      • Grant Access to a Client Session
      • Delete a Client Session
    • Connect Webviews
      • Create a Connect Webview
      • List Connect Webviews
      • Get a Connect Webview
      • Delete a Connect Webview
    • Connected Accounts
      • Get a Connected Account
      • List Connected Accounts
      • Update a Connected Account
      • Delete a Connected Account
    • Devices
      • List Devices
      • List Device Providers
      • Device Provider Metadata
      • Get a Device
      • Update a Device
      • Unmanaged Devices
        • Update an Unmanaged Device
        • List Unmanaged Devices
        • Get an Unmanaged Device
    • Access Codes
      • Create an Access Code
      • Create Multiple Linked Access Codes
      • List Access Codes
      • Get an Access Code
      • Update an Access Code
      • Update Multiple Linked Access Codes
      • Report Device Access Code Constraints
      • Delete an Access Code
      • Pull Backup Access Code
      • Unmanaged Access Codes
        • List Unmanaged Access Codes
        • Convert an Unmanaged Access Code
        • Delete an Unmanaged Access Code
    • Locks
      • Get Lock
      • Lock a Lock
      • Unlock a Lock
      • List Locks
    • Access Control Systems
      • Systems
        • List ACS Systems
        • Get an ACS System
        • List Compatible Credential Manager ACS Systems
      • ACS Users
        • Create an ACS User
        • List ACS Users
        • Get an ACS User
        • Update an ACS User
        • Suspend an ACS User
        • Unsuspend an ACS User
        • Delete an ACS User
        • Add an ACS User to an Access Group
        • Remove an ACS User from an Access Group
      • Entrances
        • List Entrances
        • Get an Entrance
        • List Credentials with Access to an Entrance
      • Access Groups
        • List Access Groups
        • Get an Access Group
        • Add an ACS User to an Access Group
        • Remove an ACS User from an Access Group
        • List ACS Users in an Access Group
      • Credentials
        • Create a Credential for an ACS User
        • Assign a Credential to an ACS User
        • List Credentials
        • Get a Credential
        • Update a Credential
        • Unassign a Credential from an ACS User
        • Delete a Credential
        • List Accessible Entrances
      • Encoders
        • Encode a Credential
        • Get an Encoder
        • List Encoders
        • Scan a Credential
        • Encoder Simulations
          • Simulate that the Next Credential Encoding Will Fail
          • Simulate that the Next Credential Encoding Will Succeed
          • Simulate that the Next Credential Scan Will Fail
          • Simulate that the Next Credential Scan Will Succeed
    • Noise Sensors
      • Noise Thresholds
        • Create Noise Thresholds
        • List Noise Thresholds
        • Update Noise Threshold
        • Delete Noise Threshold
    • Phones
      • Get a Phone
      • List Phones
      • Deactivate a Phone
      • Phone Simulations
        • Create a Sandbox Phone
    • Thermostats
      • List Thermostats
      • Set to Heat Mode
      • Set to Cool Mode
      • Set to Heat-Cool (Auto) Mode
      • Set to Off Mode
      • Set the HVAC Mode
      • Set Fan Mode
      • Activate a Climate Preset
      • Create a Climate Preset
      • Update a Climate Preset
      • Delete a Climate Preset
      • Set a Fallback Climate Preset
      • Set a Temperature Threshold
      • Thermostat Schedules
        • Get a Thermostat Schedule
        • List Thermostat Schedules
        • Create a Thermostat Schedule
        • Update a Thermostat Schedule
        • Delete a Thermostat Schedule
      • Thermostat Simulations
        • Temperature Reached
        • HVAC Mode Adjusted
    • User Identities
      • Create a User Identity
      • List User Identities
      • Get a User Identity
      • Update a User Identity
      • Add an ACS User to a User Identity
      • List ACS Users Associated with a User Identity
      • List ACS Systems Associated with a User Identity
      • Remove an ACS User from a User Identity
      • Grant a User Identity Access to a Device
      • List Accessible Devices for a User Identity
      • Revoke Access to a Device from a User Identity
      • Delete a User Identity
      • Enrollment Automations
        • Launch an Enrollment Automation
        • List Enrollment Automations
        • Get an Enrollment Automation
        • Delete an Enrollment Automation
    • Action Attempts
      • Get Action Attempt
    • Events
      • List Events
      • Get an Event
  • 🛠️Developer Tools
    • Webhooks
    • Seam CLI
    • Sandbox Devices and Systems
      • Sandbox 2N Intercoms
      • Sandbox 4SUITES Locks
      • Sandbox Akiles Locks
      • Sandbox ASSA ABLOY Credential Services
      • Sandbox ASSA ABLOY Visionline Access Control System
      • Sandbox August Locks
      • Sandbox Avigilon Alta Access System
      • Sandbox Brivo Access
      • Sandbox ControlByWeb Relays
      • Sandbox Doorking Callboxes
      • Sandbox dormakaba Oracode Locks
      • Sandbox ecobee Thermostats
      • Sandbox Genie Garage Openers
      • Sandbox Google Nest Thermostats
      • Sandbox Honeywell Resideo Thermostats
      • Sandbox igloohome Locks
      • Sandbox Kwikset Locks
      • Sandbox Latch Access Control System
      • Sandbox Linear Callboxes
      • Sandbox Lockly Locks
      • Sandbox Minut Sensors
      • Sandbox NoiseAware Sensors
      • Sandbox Nuki Locks
      • Sandbox PTI Storlogix Cloud
      • Sandbox Salto KS Access Control System
      • Sandbox Salto Locks
      • Sandbox Salto Space Access System
      • Sandbox Schlage Encode Locks
      • Sandbox Seam Bridge
      • Sandbox SmartThings Hub
      • Sandbox Tedee Locks
      • Sandbox TTLock Locks
      • Sandbox Wyze Locks
      • Sandbox Yale Locks
    • Rate Limits and Guardrails
    • Mobile SDKs
      • Android SDK
      • iOS SDK
  • 🎛️Device and System Integration Guides
    • Overview
    • 2N Intercom Systems
      • Get started with 2N Intercoms
    • 33 Lock Devices
      • Get started with 33 Lock devices
    • 4SUITES Locks
      • Get started with 4SUITES locks
    • Akiles Locks
      • Get started with Akiles locks
    • ASSA ABLOY Credential Services
    • ASSA ABLOY Visionline Access Control System
      • Visionline ACS Setup Instructions
        • Developing and Launching Your Visionline Plastic Card Encoding App
          • Developing Your Visionline Plastic Card Encoding App Using a Real Visionline Server
            • Step 1: Install Your Visionline Application
            • Step 2: Unblock Required Ports
            • Step 3: Configure a Visionline User Account
            • Step 4: Install a Visionline Card Encoder
            • Step 5: Set up Door Locks
            • Step 6: Program Door Locks
            • Step 7: Create a Production Workspace
            • Step 8: Connect Your Visionline Development Account to Seam
            • Next Steps
          • Developing Your Visionline Plastic Card Encoding App Using a Sandbox Workspace
            • Step 1: Create a Sandbox Workspace
            • Step 2: Connect the Virtual Visionline ACS to Seam
            • Next Steps
          • Launching Your Visionline Plastic Card Encoding App to a Live Site
            • Step 1: Confirm That Your Visionline Site Meets the Requirements
            • Step 2: Configure a Visionline User Account
            • Step 3: Purchase and Import the Callback Option from ASSA ABLOY
            • Step 4: Create a Production Workspace
            • Step 5: Connect Your Visionline Production Account to Seam
        • Developing and Launching Your Visionline Mobile Key App
          • Developing Your Visionline Mobile Key App
            • Step 1: Complete the ASSA ABLOY Mobile Development Course
            • Step 2: Install Your Visionline Application
            • Step 3: Unblock Required Ports
            • Step 4: Configure a Visionline User Account
            • Step 5: Set up Your Credential Services Account in Visionline
            • Step 6: Configure the Mobile Access UUID in Visionline
            • Step 7: Set up Door Locks with BLE Profiles
            • Step 8: Program Door Locks
            • Step 9: Create a Production Workspace
            • Step 10: Connect Your Visionline Development Account to Seam
            • Next Steps
          • Launching Your Visionline Mobile Key App
            • Step 1: Obtain ASSA ABLOY Certification for Your Mobile Key App
            • Step 2: Confirm That Your Visionline Site Meets the Requirements
            • Step 3: Confirm BLE Module on All Locks
            • Step 4: Set up Door Locks with BLE Profiles
            • Step 5: Program Door Locks
            • Step 6: Configure a Visionline User Account
            • Step 7: Purchase and Import the Callback and Mobile Service Options from ASSA ABLOY
            • Step 8: Create a Production Workspace
            • Step 9: Connect Your Visionline Production Account to Seam
      • Configuring Visionline Mobile Credentials
        • Issuing Various Types of Guest Mobile Credentials
        • Issuing Various Types of Guest Joiner Mobile Credentials
        • Retrieving Guest and Common Entrances
        • Checking if a User Identity Has a Phone That Is Set up for a Credential Manager
        • Updating Guest Mobile Credentials
        • Revoking Mobile Credentials
      • Mobile Credential-Related Properties
      • Common Use Cases
      • Special Requirements for Android Mobile Access SDK Development
      • Special Requirements for iOS Mobile Access SDK Development
      • Creating Visionline Card-based Credentials
    • August Locks
      • Get started with August locks
    • Avigilon Alta Access System
    • Brivo Access
    • Get started with ControlByWeb Devices
    • dormakaba Oracode Locks
      • Get started with dormakaba Oracode Locks
      • Creating dormakaba Oracode Offline Access Codes
    • ecobee Thermostats
      • Get Started with ecobee Thermostats
    • Google Nest Thermostats
      • Get Started with Nest Thermostats
      • Obtain Google Nest Device Access and Commercial Development
    • Honeywell Resideo Thermostats
      • Get Started with Honeywell Resideo Thermostats
    • igloohome Locks
      • Get started with igloohome Locks
      • Creating igloohome Offline Access Codes
    • Kwikset Locks
      • Get started with Kwikset Wi-Fi Locks
    • Latch Access Control System
      • Latch ACS Setup Instructions
      • Programming Code-Based Latch Credentials
      • Programming Latch ACS Mobile Credentials
    • Lockly Locks
      • Creating Lockly Offline Access Codes
    • Minut Sensors
      • Get started with Minut Sensors
    • NoiseAware Sensors
      • Get started with NoiseAware Sensors
    • Nuki Locks
      • Get Started with Nuki Locks
    • PTI Storlogix Cloud
    • Salto KS Access Control System
      • Salto KS Setup Instructions
      • Programming Salto KS PIN Code Credentials
      • Programming Salto KS Mobile Credentials
      • Special Requirements for Android Mobile Access SDK Development
    • Salto KS Locks
      • Get started with Salto KS Locks
    • Salto ProAccess Space Access System
      • Salto Space Setup Instructions
      • Programming Salto Space Card-based Credentials
      • Programming Salto Space Mobile Credentials
    • Schlage Locks
      • Schlage Locks Setup Instructions
      • Get started with Schlage Locks
    • SmartThings Hubs + Smart Locks
      • Get started with SmartThings Hubs + Smart Locks
    • Tedee Locks
      • Get Started with Tedee Locks
    • TTLock Locks
      • Get started with TTLock Locks
    • Wyze Locks
      • Get started with Wyze Locks
    • Yale Locks
      • Get started with Yale Locks
    • Get started with Smart Locks
  • Device Manufacturer Guidance
    • Creating a Seam-Compatible Intercom API
      • Creating OAuth Endpoints
      • Creating Intercom CRUD Endpoints
      • Creating Access Code CRUD Endpoints
      • Creating the Health Endpoint
    • Creating a Seam-Compatible Door Locks API
      • Creating OAuth Endpoints
      • Creating Door Lock CRUD Endpoints
      • Creating Access Code CRUD Endpoints
      • Creating the Health Endpoint
Powered by GitBook
LogoLogo

Get Started

  • Sign Up
  • Supported Devices

News

  • Changelog
  • Blog

Company

  • About
  • Privacy Notice

© Seam Labs, Inc. All rights reserved.

On this page
  • 1. Update the access code using the API
  • 2. Verify that the access code has been updated
  • For a permanent access code
  • For a time-bound access code
  • Special Case #1: Changing an ongoing access code to time-bound access
  • Special Case #2: Changing a time-bound access code to permanent access

Was this helpful?

Edit on GitHub
  1. Capability Guides
  2. Smart Locks
  3. Creating and Managing Smart Lock Access Codes

Modifying Access Codes

Learn how to update your access codes, and ensure that the changes are successfully set on the device.

PreviousRetrieving Access CodesNextDeleting Access Codes

Last updated 3 months ago

Was this helpful?

1. Update the access code using the API

You can update any active or upcoming access codes using the request.

When modifying an access code, adjust the properties of the access code, such as the code, name, starts_at, and ends_at to the new desired values.

Code:

seam.access_codes.update(
  access_code = "11111111-1111-1111-1111-555555555555",
  name = "my updated code name",
  code = "5432",
  starts_at = "2025-02-01T16:00:00Z",
  ends_at = "2025-02-22T12:00:00Z"
)

Output:

None

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/update' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "name": "my updated code name",
  "code": "5432",
  "starts_at": "2025-02-01T16:00:00Z",
  "ends_at": "2025-02-22T12:00:00Z"
}'

Response:

{
  "ok": true
}

Code:

await seam.accessCodes.update({
  access_code_id: "11111111-1111-1111-1111-555555555555",
  name: "my updated code name",
  starts_at: "2025-02-01T16:00:00Z",
  ends_at: "2025-02-22T12:00:00Z",
  code: "5432"
})

Output:

void

Code:

client.access_codes.update(
  access_code_id: "11111111-1111-1111-1111-555555555555",
  name: "my updated code name",
  starts_at: "2025-02-01T16:00:00Z",
  ends_at: "2025-02-22T12:00:00Z",
  code: "5432"
)

Output:

nil

Code:

$seam->access_codes->update(
  access_code_id: "11111111-1111-1111-1111-555555555555",
  name: "my updated code name",
  starts_at: "2025-02-01T16:00:00Z",
  ends_at: "2025-02-22T12:00:00Z",
  code: "5432"
);

Output:

void

Code:

seam.AccessCodes.Update(
  accessCodeId: "11111111-1111-1111-1111-555555555555",
  name: "my updated code name",
  startsAt: "2025-02-01T16:00:00Z",
  endsAt: "2025-02-22T12:00:00Z",
  code: "5432"
);

Output:

void

Code:

seam.accessCodes().update(AccessCodesUpdateRequest.builder()
  .accessCodeId("11111111-1111-1111-1111-555555555555")
  .name("my updated code name")
  .startsAt("2025-02-01T16:00:00Z")
  .endsAt("2025-02-22T12:00:00Z")
  .code("5432")
  .build());

Output:

void

Code:

startsAt, err := time.Parse(time.RFC3339, "2025-02-01T16:00:00Z")
endsAt, err := time.Parse(time.RFC3339, "2025-02-22T12:00:00Z")
if err != nil {
  return err
}

client.AccessCodes.Update(
  context.Background(),
  &api.AccessCodesUpdateRequest{
    AccessCodeId: api.String("11111111-1111-1111-1111-555555555555"),
    Name: api.String("my updated code name"),
    StartsAt: startsAt,
    EndsAt: endsAt,
    Code: api.String("5432"),
  },
)

Output:

void

2. Verify that the access code has been updated

For a permanent access code

There are two methods to verify that a permanent access code has been set on the device:

Polling Method

Webhook Events Method

Monitor the incoming events on your webhook. Be on the lookout for the access_code.set_on_device event, which indicates the successful setting of the access code on the device.

For a time-bound access code

There are two methods to verify that a time-bound access code has been set on the device:

Polling Method

Webhook Events Method

Monitor the incoming events on your webhook. Be on the lookout for the access_code.set_on_device event, which indicates the successful setting of the access code on the device.


Special Case #1: Changing an ongoing access code to time-bound access

To convert a permanent access code to time-bound access, you must set the starts_at and ends_at properties to the timeframe that you want for the access code.

1. Confirm that the access code starts as an ongoing code.

Code:

access_code = seam.access_codes.get(
  access_code_id = "11111111-1111-1111-1111-555555555555"
)

Output:

AccessCode(
  access_code_id='11111111-1111-1111-1111-555555555555',
  type='ongoing',
  ...
)

2. Update the code to set starts_at and ends_at timestamps.

Code:

seam.access_codes.update(
  access_code = "11111111-1111-1111-1111-555555555555",
  starts_at = "2025-01-01T16:00:00Z",
  ends_at = "2025-01-22T12:00:00Z"
)

Output:

None

3. Confirm that the type has changed to time_bound.

Code:

seam.access_codes.get(
  access_code_id = "11111111-1111-1111-1111-555555555555"
)

Output:

AccessCode(
  access_code_id='11111111-1111-1111-1111-555555555555',
  type='time_bound',
  starts_at='2025-01-01T16:00:00.000Z',
  ends_at='2025-01-22T12:00:00.000Z',
  ...
)

1. Confirm that the access code starts as an ongoing code.

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/access_codes/get' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-555555555555"
}'

Response:

{
  "access_code": {
    "access_code_id": "11111111-1111-1111-1111-555555555555",
    "type": "ongoing",
    ...
  },
  "ok": true
}

2. Update the code to set starts_at and ends_at timestamps.

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/update' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "starts_at": "2025-01-01T16:00:00Z",
  "ends_at": "2025-01-22T12:00:00Z"
}'

Response:

{
  "ok": true
}

3. Confirm that the type has changed to time_bound.

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/access_codes/get' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-555555555555"
}'

Response:

{
  "access_code": {
    "access_code_id": "11111111-1111-1111-1111-555555555555",
    "type": "time_bound",
    "starts_at": "2025-01-01T16:00:00.000Z",
    "ends_at": "2025-01-22T12:00:00.000Z",
    ...
  },
  "ok": true
}

1. Confirm that the access code starts as an ongoing code.

Code:

await seam.accessCodes.get({
  access_code_id: "11111111-1111-1111-1111-555555555555"
});

Output:

{
  access_code_id: '11111111-1111-1111-1111-555555555555',
  type: 'ongoing',
  ...
}

2. Update the code to set starts_at and ends_at timestamps.

Code:

await seam.accessCodes.update({
  access_code_id: "11111111-1111-1111-1111-555555555555",
  starts_at: "2025-02-01T16:00:00Z",
  ends_at: "2025-02-22T12:00:00Z"
});

Output:

void

3. Confirm that the type has changed to time_bound.

Code:

await seam.accessCodes.get({
  access_code_id: "11111111-1111-1111-1111-555555555555"
});

Output:

{
  access_code_id: '11111111-1111-1111-1111-555555555555',
  type: 'time_bound',
  starts_at: '2025-02-01T16:00:00.000Z',
  ends_at: '2025-02-22T12:00:00.000Z',
  ...
}

1. Confirm that the access code starts as an ongoing code.

Code:

client.access_codes.get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
)

Output:

<Seam::AccessCode:0x00438
  access_code_id="11111111-1111-1111-1111-555555555555"
  type="ongoing"
  ...
>

2. Update the code to set starts_at and ends_at timestamps.

Code:

client.access_codes.update(
  access_code_id: "11111111-1111-1111-1111-555555555555",
  starts_at: "2025-02-01T16:00:00Z",
  ends_at: "2025-02-22T12:00:00Z"
)

Output:

nil

3. Confirm that the type has changed to time_bound.

Code:

client.access_codes.get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
)

Output:

<Seam::AccessCode:0x00438
  access_code_id="11111111-1111-1111-1111-555555555555"
  type="time_bound"
  starts_at=2025-02-01 16:00:00 UTC
  ends_at=2025-02-22 12:00:00 UTC
  ...
>

1. Confirm that the access code starts as an ongoing code.

Code:

$seam->access_codes->get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "ongoing",
  ...
}

2. Update the code to set starts_at and ends_at timestamps.

Code:

$seam->access_codes->update(
  access_code_id: "11111111-1111-1111-1111-555555555555",
  starts_at: "2025-02-01T16:00:00Z",
  ends_at: "2025-02-22T12:00:00Z"
);

Output:

void

3. Confirm that the type has changed to time_bound.

Code:

$seam->access_codes->get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

1. Confirm that the access code starts as an ongoing code.

Code:

seam.AccessCodes.Get(
  accessCodeId: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "ongoing",
  ...
}

2. Update the code to set starts_at and ends_at timestamps.

Code:

seam.AccessCodes.Update(
  accessCodeId: "11111111-1111-1111-1111-555555555555",
  startsAt: "2025-02-01T16:00:00Z",
  endsAt: "2025-02-22T12:00:00Z"
);

Output:

void

3. Confirm that the type has changed to time_bound.

Code:

seam.AccessCodes.Get(
  accessCodeId: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

1. Confirm that the access code starts as an ongoing code.

Code:

seam.accessCodes().get(AccessCodesGetRequest.builder()
  .accessCodeId("11111111-1111-1111-1111-555555555555")
  .build());

Output:

{
  "access_code_id" : "11111111-1111-1111-1111-555555555555",
  "type" : "ongoing",
  ...
}

2. Update the code to set starts_at and ends_at timestamps.

Code:

seam.accessCodes().update(AccessCodesUpdateRequest.builder()
  .accessCodeId("11111111-1111-1111-1111-555555555555")
  .startsAt("2025-02-01T16:00:00Z")
  .endsAt("2025-02-22T12:00:00Z")
  .build());

Output:

void

3. Confirm that the type has changed to time_bound.

Code:

seam.accessCodes().get(AccessCodesGetRequest.builder()
  .accessCodeId("11111111-1111-1111-1111-555555555555")
  .build());

Output:

{
  "access_code_id" : "11111111-1111-1111-1111-555555555555",
  "type" : "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

1. Confirm that the access code starts as an ongoing code.

Code:

client.AccessCodes.Get(
  context.Background(),
  &api.AccessCodesGetRequest{
    AccessCodeId: api.String("11111111-1111-1111-1111-555555555555"),
  },
)

Output:

{
  "access_code_id" : "11111111-1111-1111-1111-555555555555",
  "type" : "ongoing",
  ...
}

2. Update the code to set starts_at and ends_at timestamps.

Code:

startsAt, err := time.Parse(time.RFC3339, "2025-02-01T16:00:00Z")
endsAt, err := time.Parse(time.RFC3339, "2025-02-22T12:00:00Z")
if err != nil {
  return err
}

client.AccessCodes.Update(
  context.Background(),
  &api.AccessCodesUpdateRequest{
    AccessCodeId: api.String("11111111-1111-1111-1111-555555555555"),
    StartsAt: startsAt,
    EndsAt: endsAt,
  },
)

Output:

void

3. Confirm that the type has changed to time_bound.

Code:

client.AccessCodes.Get(
  context.Background(),
  &api.AccessCodesGetRequest{
    AccessCodeId: api.String("11111111-1111-1111-1111-555555555555"),
  },
)

Output:

{
  "access_code_id" : "11111111-1111-1111-1111-555555555555",
  "type" : "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

Special Case #2: Changing a time-bound access code to permanent access

When converting a time-bound code to a permanent one, you'll also need to set the type property of the access code to ongoing.

1. Confirm that the access code starts as a time-bound code.

Code:

seam.access_codes.get(
  access_code_id = "11111111-1111-1111-1111-555555555555"
)

Output:

AccessCode(
  access_code_id='11111111-1111-1111-1111-555555555555',
  type='time_bound',
  starts_at='2025-01-01T16:00:00.000Z',
  ends_at='2025-01-22T12:00:00.000Z',
  ...
)

2. Update the code to set the type to ongoing.

Code:

seam.access_codes.update(
  access_code_id = "11111111-1111-1111-1111-555555555555",
  type = "ongoing"
)

Output:

None

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Code:

seam.access_codes.get(
  access_code_id = "11111111-1111-1111-1111-555555555555"
)

Output:

AccessCode(
  access_code_id='11111111-1111-1111-1111-555555555555',
  type='ongoing',
  ...
)

1. Confirm that the access code starts as a time-bound code.

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/access_codes/get' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-555555555555"
}'

Response:

{
  "access_code": {
    "access_code_id": "11111111-1111-1111-1111-555555555555",
    "type": "time_bound",
    "starts_at": "2025-01-01T16:00:00.000Z",
    "ends_at": "2025-01-22T12:00:00.000Z",
    ...
  },
  "ok": true
}

2. Update the code to set the type to ongoing.

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/update' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "ongoing"
}'

Response:

{
  "ok": true
}

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/access_codes/get' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "access_code_id": "11111111-1111-1111-1111-555555555555"
}'

Response:

{
  "access_code": {
    "access_code_id": "11111111-1111-1111-1111-555555555555",
    "type": "ongoing",
    ...
  },
  "ok": true
}

1. Confirm that the access code starts as a time-bound code.

Code:

await seam.accessCodes.get({
  access_code_id: "11111111-1111-1111-1111-555555555555"
});

Output:

{
  access_code_id: '11111111-1111-1111-1111-555555555555',
  type: 'time_bound',
  starts_at: '2025-02-01T16:00:00.000Z',
  ends_at: '2025-02-22T12:00:00.000Z',
  ...
}

2. Update the code to set the type to ongoing.

Code:

await seam.accessCodes.update({
  access_code_id: "11111111-1111-1111-1111-555555555555",
  type: "ongoing"
});

Output:

void

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Code:

await seam.accessCodes.get({
  access_code_id: "11111111-1111-1111-1111-555555555555"
});

Output:

{
  access_code_id: '11111111-1111-1111-1111-555555555555',
  type: 'ongoing',
  ...
}

1. Confirm that the access code starts as a time-bound code.

Code:

client.access_codes.get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
)

Output:

<Seam::AccessCode:0x00438
  access_code_id="11111111-1111-1111-1111-555555555555"
  type="time_bound"
  starts_at=2025-02-01 16:00:00 UTC
  ends_at=2025-02-22 12:00:00 UTC
  ...
>

2. Update the code to set the type to ongoing.

Code:

client.access_codes.update(
  access_code_id: "11111111-1111-1111-1111-555555555555",
  type: "ongoing"
)

Output:

nil

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Code:

client.access_codes.get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
)

Output:

<Seam::AccessCode:0x00438
  access_code_id="11111111-1111-1111-1111-555555555555"
  type="ongoing"
  ...
>

1. Confirm that the access code starts as a time-bound code.

Code:

$seam->access_codes->get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

2. Update the code to set the type to ongoing.

Code:

$seam->access_codes->update(
  access_code_id: "11111111-1111-1111-1111-555555555555",
  type: "ongoing"
);

Output:

void

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Code:

$seam->access_codes->get(
  access_code_id: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "ongoing",
  ...
}

1. Confirm that the access code starts as a time-bound code.

Code:

seam.AccessCodes.Get(
  accessCodeId: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

2. Update the code to set the type to ongoing.

Code:

seam.AccessCodes.Update(
  accessCodeId: "11111111-1111-1111-1111-555555555555",
  type: Seam.Api.AccessCodes.UpdateRequest.TypeEnum.Ongoing
);

Output:

void

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Code:

seam.AccessCodes.Get(
  accessCodeId: "11111111-1111-1111-1111-555555555555"
);

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "ongoing",
  ...
}

1. Confirm that the access code starts as a time-bound code.

Code:

seam.accessCodes().get(AccessCodesGetRequest.builder()
  .accessCodeId("11111111-1111-1111-1111-555555555555")
  .build());

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

2. Update the code to set the type to ongoing.

Code:

seam.accessCodes().update(AccessCodesUpdateRequest.builder()
  .accessCodeId("11111111-1111-1111-1111-555555555555")
  .type(AccessCodesUpdateRequestType.ONGOING)
  .build());

Output:

void

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Code:

seam.accessCodes().get(AccessCodesGetRequest.builder()
  .accessCodeId("11111111-1111-1111-1111-555555555555")
  .build());

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "ongoing",
  ...
}

1. Confirm that the access code starts as a time-bound code.

Code:

client.AccessCodes.Get(
  context.Background(),
  &api.AccessCodesGetRequest{
    AccessCodeId: api.String("11111111-1111-1111-1111-555555555555"),
  },
)

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "time_bound",
  "starts_at": "2025-02-01T16:00:00.000Z",
  "ends_at": "2025-02-22T12:00:00.000Z",
  ...
}

2. Update the code to set the type to ongoing.

Code:

client.AccessCodes.Update(
  context.Background(),
  &api.AccessCodesUpdateRequest{
    AccessCodeId: api.String("11111111-1111-1111-1111-555555555555"),
    Type: api.AccessCodesUpdateRequestTypeOngoing.Ptr(),
  },
)

Output:

void

3. Confirm that the type has changed to ongoing and the starts_at and ends_at are None.

Code:

client.AccessCodes.Get(
  context.Background(),
  &api.AccessCodesGetRequest{
    AccessCodeId: api.String("11111111-1111-1111-1111-555555555555"),
  },
)

Output:

{
  "access_code_id": "11111111-1111-1111-1111-555555555555",
  "type": "ongoing",
  ...
}

Utilize the access_code_id returned in the response from the create endpoint to invoke the endpoint. A basic implementation would involve polling this endpoint until the status of the access code updates to set.

If the status remains setting for a very long time, or if the access_code object contains any warnings or errors properties, consult for further guidance.

However, if you receive access_code.failed_to_set_on_device or access_code.delay_in_setting_on_device events, it's crucial to refer to for assistance.

Use the access_code_id provided in the response from the create endpoint to call the endpoint. In a basic implementation, you would poll this endpoint at the starts_at time to check if the access code's status is updated to set.

If the status remains setting, or if the access_code object displays any warnings or errors, refer to for assistance.

However, if you receive access_code.failed_to_set_on_device or access_code.delay_in_setting_on_device events, it's crucial to refer to for assistance.

🔒
Update Access Code
Get Access Code
our guide on "Troubleshooting Access Code Issues"
the "Troubleshooting access code issues" guide
Get Access Code
our "Troubleshooting Access Code Issues" guide
the "Troubleshooting access code issues" guide