Selective update location

Selectively update a location

POST /api/location/selectiveUpdateLocation

Selective update location

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/location/selectiveUpdateLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

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 selectively updating a location.

locationUuid · string<RUUID> | null · required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

address1 · string | null

First line of the address

address2 · string | null

Second line of the address

countryCode · string | null

Country code of the location

floorPlans · object[] | null

Floor plans for the location

Show child attributes

labels · (string | null)[] | null

Labels offer a way to perform operations across multiple locations if they have the same label

Labels offer a way to perform operations across multiple locations if they have the same label

latitude · number<double> | null

Latitude coordinate of the location

longitude · number<double> | null

Longitude coordinate of the location

name · string | null

Name of this location

policyUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

postalCode · string | null

Postal code of the location

timezoneId · string | null

Timezone identifier, e.g. America/Los_Angeles, EST, GMT+0, etc.

tz · object

Use timezoneId field instead

Show child attributes

Response

200 - application/json

object | null

OK

Response object for selectively updating a location.

error · boolean | null

errorMsg · string | null

warningMsg · string | null