Delete an Unmanaged Access Code

Delete an Unmanaged Access Code

DELETE https://connect.getseam.com/access_codes/unmanaged/delete

Query Parameters

Name	Type	Description
access_code_id*	String

200: OK Returns an Action Attempt

{
  "action_attempt": {
    "status": "pending",
    "action_type": "DELETE_ACCESS_CODE",
    "action_attempt_id": "6a5e05e3-fd92-4211-aecb-ac53f1382ea1",
    "result": null,
    "error": null
  },
  "ok": true
}

400: Bad Request

{
  "error": {
    "type": "invalid_input",
    "message": "Required for provided \"access_code_id\"",
    "validation_errors": {
      "_errors": [],
      "access_code_id": {
        "_errors": [
          "Required"
        ]
      }
    },
    "request_id": "33d23234-4d59-4321-b495-01dec55ee145"
  },
  "ok": false
}

404: Not Found

{
  "error": {
    "type": "access_code_not_found",
    "message": "Could not find a device with access_code_id",
    "data": {
      "access_code_id": "a9f662a7-44fb-4b91-b7a8-22c0f996bfc1"
    },
    "request_id": "dc6427ed-b493-4cb3-b81b-b1c9a50f18fd"
  },
  "ok": false
}

Code Example

Javascript

await seam.accessCodes.unmanaged.delete({
  access_code_id: "a9f662a7-44fb-4b91-b7a8-22c0f996bfc1",
});

PHP

$seam->access_codes->unmanaged->delete(
  access_code_id: '26d6138c-6524-4f3c-ac96-43cc3bea0a8d',
);

Parameters

access_code_id	type: string	ID of the Access Code

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": "DELETE_ACCESS_CODE",
    "action_attempt_id": "6a5e05e3-fd92-4211-aecb-ac53f1382ea1",
    "result": null,
    "error": null
  },
  "ok": true
}