Deleting Access Codes

Learn how to delete your access codes, and ensure that the code is successfully removed from the device.

1. Delete the access code using the API

To delete an access code, specify the desired access_code_id in the Delete Access Code request.

Python

Code:

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

Output:

None

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/delete' \
  -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:

{
  "ok": true
}

JavaScript

Code:

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

Output:

void

Ruby

Code:

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

Output:

void

PHP

Code:

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

Output:

void

C#

Code:

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

Output:

void

Java

Code:

seam.accessCodes()
  .delete(AccessCodesDeleteRequest.builder()
    .accessCodeId("11111111-1111-1111-1111-555555555555")
    .build());

Output:

void

Go

Code:

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

Output:

void

---

2. Verify that the access code has been removed

Poll for or configure a webhook to listen for an access_code.deleted or access_code.removed_from_device event containing the access_code_id of the access code that you've deleted. Note that if you delete an access code that was never programmed onto a device, Seam does not emit an access_code.removed_from_device event for this access code.

If you receive access_code.failed_to_remove_from_device or access_code.delay_in_removing_from_device events, see Troubleshooting Access Code Issues.