PUT
/
wallet-pass-location
/
{locationId}
Update a Pass Location
curl --request PUT \
  --url https://api.ubpass.co/v1/wallet-pass-location/{locationId} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "name": "TORONTO MALL LOCATION - UPDATED",
  "enabled": true,
  "latitude": 43.798327702071944,
  "longitude": -79.24175240232819,
  "relevantText": "Welcome to Toronto Premium Outlets - Updated",
  "walletPass": {
    "id": "1f07ee39-d750-6276-aff4-07a599527878"
  }
}'
{
  "id": "1f089d37-5ebe-6778-af59-99631cec7ab5",
  "createdTime": "2025-09-04T21:09:36.027Z",
  "updatedTime": "2025-09-04T21:15:42.123Z",
  "createdBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "updatedBy": "1ef58ae6-40ac-6fd2-96af-45801844c4e2",
  "workspaceId": "1f089d29-6f9c-66c2-af59-99631cec7ab5",
  "accountId": "1f089d29-6fa8-6a13-af59-99631cec7ab5",
  "name": "TORONTO MALL LOCATION - UPDATED",
  "enabled": true,
  "latitude": 43.798327702071944,
  "longitude": -79.24175240232819,
  "relevantText": "Welcome to Toronto Premium Outlets - Updated",
  "walletPass": {
    "id": "1f07ee39-d750-6276-aff4-07a599527878"
  }
}

Authorizations

​
api-key
string
header
required

API Key authentication

Headers

​
x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Path Parameters

​
locationId
string
required

Unique identifier of the wallet pass location to update

Body

application/json

Updated wallet pass location data including name, coordinates, and wallet pass reference

​
name
string
required

Name of the location. This field is required and has a maximum length of 255 characters.

Maximum length: 255
Example:

"Main Store"

​
latitude
number
required

Latitude of the location in degrees. This field is required.

Example:

37.7749

​
longitude
number
required

Longitude of the location in degrees. This field is required.

Example:

-122.4194

​
relevantText
string
required

Text to display on the lock screen when the user is near this location. This field is required and has a maximum length of 255 characters.

Maximum length: 255
Example:

"You are near Main Store!"

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
createdBy
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

The ID of the workspace to which this entity belongs.

​
enabled
boolean

Indicates whether the location is enabled. If true, the pass may trigger a notification when the user is near this location. Default is true if not specified.

Example:

true

​
altitude
number

Altitude of the location in meters. Optional.

Example:

10.5

Response

Wallet pass location updated successfully

​
name
string
required

Name of the location. This field is required and has a maximum length of 255 characters.

Maximum length: 255
Example:

"Main Store"

​
latitude
number
required

Latitude of the location in degrees. This field is required.

Example:

37.7749

​
longitude
number
required

Longitude of the location in degrees. This field is required.

Example:

-122.4194

​
relevantText
string
required

Text to display on the lock screen when the user is near this location. This field is required and has a maximum length of 255 characters.

Maximum length: 255
Example:

"You are near Main Store!"

​
id
string
​
createdTime
string<date-time>

The time when the entity was created in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
updatedTime
string<date-time>

The time when the entity was last updated in ISO 8601 format including milliseconds and timezone offset.

Example:

"2025-05-13T15:07:15.036Z"

​
createdBy
string

The user who created the entity.

​
updatedBy
string

The user who last updated the entity.

​
workspaceId
string

The ID of the workspace to which this entity belongs.

​
enabled
boolean

Indicates whether the location is enabled. If true, the pass may trigger a notification when the user is near this location. Default is true if not specified.

Example:

true

​
altitude
number

Altitude of the location in meters. Optional.

Example:

10.5