Update Physical Location

Description

This method allows for updating the profile of a currently logged-in physical location.


Request

Restrictions

This service requires an authenticated user and can only be called after a successful physical location login.

Endpoint

PUT https://<server-url>/api/v4/physicallocation

Parameters

Parameter
Location
Description

touchpoint

Query / Header

The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.

token

Query / Header

The authentication token for the API session. Use Thalamus-Token for the header.

activity

Query / Header

Optional. The activity to be used. Use Thalamus-Activity for the header.

Content-Type

Header

Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v4/physicallocation?touchpoint=test&token=...

Request Body

The request body contains the updated information for the physical location's profile, point of sale data, and opt-in settings.

Field
Type
Description

profile

Object

Contains the physical location's core profile data. For a full list of available fields, see the Get Profile Fields document.

point_of_sale

Object

Contains point of sale specific data. See structure below.

optIns

Array

Manages communication opt-in and opt-out preferences.

Point of Sale Fields

Field
Type
Description

active

Boolean

Indicates if the point of sale is active.

salesroute

Integer

The ID of the sales route.

owner

String

The principal (e.g., email) of the owner.

employees

Array

An array of employee IDs associated with the location.

JSON

{
  "profile": {
    "name": "Lugar DOS",
    "fiscalId": 12345678,
    "email": "[email protected]",
    "address": {
      "countryId": 1,
      "street1": "Linares 945",
      "postalCode": "1425",
      "city": "CABA",
      "stateId": 2
    }
  },
  "point_of_sale": {
    "active": true,
    "salesroute": 1,
    "owner": "[email protected]",
    "employees": [
      2,
      6
    ]
  },
  "optIns": [
    {
      "brandFamilyId": 1,
      "channel": 6001,
      "accepted": false
    }
  ]
}

Response

✅ Successful Response: 200 OK

The physical location's profile has been successfully updated. The response returns the updated session context.

JSON

{
  "context": {
    "links": [
      {
        "ref": "home",
        "href": "http://localhost:8080/thalamus/api/v4/people/home"
      }
    ],
    "activities": [
      {
        "code": "EMileage",
        "name": "E Mileage"
      }
    ],
    "simpleProfile": {
      "me": false,
      "urlAvatar": ""
    }
  }
}

❌ Unsuccessful Response: 400 Bad Request

Returned if the provided data is invalid. For a detailed list of possible validation errors, please refer to the Unsuccessful Response section of the Person Registration method.

Last updated

Was this helpful?