Skip to main content
POST
/
api
/
proximity
/
updateDetails
Update proximity sensor details
curl --request POST \
  --url https://api2.rhombussystems.com/api/proximity/updateDetails \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data @- <<EOF
{
  "deletedUpdated": false,
  "description": "John Doe's employee badge",
  "descriptionUpdated": true,
  "imageUrl": "https://example.com/badge-image.jpg",
  "imageUrlUpdated": false,
  "name": "Employee Badge 001",
  "nameUpdated": true,
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "policyUuidUpdated": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
EOF
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for updating details for a proximity tag.

deletedUpdated
boolean | null

Whether the deleted status has been updated

Example:

false

description
string | null

Description of the proximity tag

Example:

"John Doe's employee badge"

descriptionUpdated
boolean | null

Whether the description has been updated

Example:

true

imageUrl
string | null

URL of the image for the proximity tag

Example:

"https://example.com/badge-image.jpg"

imageUrlUpdated
boolean | null

Whether the image URL has been updated

Example:

false

name
string | null

Name of the proximity tag

Example:

"Employee Badge 001"

nameUpdated
boolean | null

Whether the name has been updated

Example:

true

policyUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

policyUuidUpdated
boolean | null

Whether the policy UUID has been updated

Example:

true

uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating details for a proximity tag.

error
boolean | null
errorMsg
string | null
warningMsg
string | null