Unlock a Lock

Issue an unlock command on the Device by its Device ID

Unlock Door for Device

POST https://connect.getseam.com/locks/unlock_door

Headers

Name	Type	Description
Authorization*	String	Bearer <API_KEY>

Request Body

Name	Type	Description
device_id*	String	ID of device to be unlocked

200: OK

{
  "action_attempt": {
    "status": "pending",
    "action_type": "UNLOCK_DOOR",
    "action_attempt_id": "e685a885-5f16-4b4d-acd1-22f5c00c6786",
    "result": null,
    "error": null
  },
  "ok": true
}

400: Bad Request

{
  "error": {
    "type": "invalid_input",
    "message": "Required for provided \"device_id\"",
    "validation_errors": {
      "_errors": [],
      "device_id": {
        "_errors": [
          "Required"
        ]
      }
    },
    "request_id": "87ff554d-e27f-474d-b0f9-200c38ac3ab4"
  },
  "ok": false
}

404: Not Found

{
  "error": {
    "type": "device_not_found",
    "message": "Device not found",
    "request_id": "cda51712-7c52-482b-910d-04bc93fb4782"
  },
  "ok": false
}

Code Example

Ruby

seam.locks.unlock_door(device_id: "123e4567-e89b-12d3-a456-426614174000")

# <Seam::ActionAttempt:0x008f6b0                                                         
#   status="pending"                                                                     
#   action_type="UNLOCK_DOOR"
#   action_attempt_id="4c3f9e12-5c9e-474e-92c4-719f72e13496"
#   result={}>

Javascript

await seam.locks.unlockDoor(
  "a83690b-2b70-409a-9a94-426699b84c97"
);

//{}

Python

seam.locks.unlock_door("a83690b2-2b70-409a-9a94-426699b84c97")

# ActionAttempt(
#     action_attempt_id='f323db33-f5cb-45e0-8142-610ba1ceda51', 
#     action_type='UNLOCK_DOOR', 
#     status='success', 
#     result={}, 
#     error=None
# )

Parameters

device_id

type: string

Device ID

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "action_attempt": {
    "status": "pending",
    "action_type": "UNLOCK_DOOR",
    "action_attempt_id": "9d407023-acb3-4525-adc8-97c6dcf86104",
    "result": null,
    "error": null
  },
  "ok": true
}

status	"success" | "error" | "pending"	success determines a completed action performed on the device. error determines an unsuccessful action performed on the device. pending determines Seam is still trying to perform the action on the device
action_type	"UNLOCK_DOOR"	Determines the type of action performed on the device
action_attempt_id	String	ID of the action attempt
result	String	result only exists for the success status describing the event
error	Object	error only exists for the error status describing the event. It is an object with type and message. Where type determines type of error and message describes the error