Skip to main content
POST
Update proximity sensor details

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

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
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

policyUuidUpdated
boolean | null

Whether the policy UUID has been updated

Example:

true

uuid
string<RUUID> | null
RUUID

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
Last modified on August 22, 2026