Report Device Access Code Constraints

Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.

Specify either supported_code_lengths or min_code_length/max_code_length.

Enables you to report access code-related constraints for a device.

Code

await seam.accessCodes.reportDeviceConstraints({
  device_id: "cd17e797-e952-47a1-ba47-46bf72934181",
  supported_code_lengths: [4, 5, 6],
  min_code_length: 42,
  max_code_length: 42,
});

Output

// 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

device_id String (Required)

ID of the device for which you want to report constraints.


max_code_length Number

Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either min_code_length/max_code_length or supported_code_lengths.


min_code_length Number

Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either min_code_length/max_code_length or supported_code_lengths.


supported_code_lengths Array of Numbers

Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either supported_code_lengths or min_code_length/max_code_length.


Response

void


Examples

Report device constraints (minimum and maximum code lengths)

Enables you to report access code-related constraints for a device.

Code

await seam.accessCodes.reportDeviceConstraints({
  device_id: "cd17e797-e952-47a1-ba47-46bf72934181",
  min_code_length: 4,
  max_code_length: 6,
});

Output

// void

Last updated

Was this helpful?