Register Physical Location

Description

This service registers a new physical location and, upon successful registration, logs it in. It is used for direct registration without involving external social network connectors.

---

Request

Restrictions

This service can only be called when a physical location is not already logged in.

Endpoint

POST 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. 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 must contain the profile information, credentials, and any communication opt-ins for the new physical location.

Field	Type	Description
profile	Object	An object containing the physical location's profile data. For a full list of available fields, see the Get Profile Fields document.
optIns	Array	An array of opt-in objects for communication channels.
ownerPartnerPrincipal	String	Optional. The principal identifier of an existing partner to associate this new physical location with. The system validates that the principal exists and belongs to a partner.
credential	Object	An object containing the login credentials for the new location. See structure below.

credential Object Fields

Field	Type	Description
principal	String	The primary identifier for login (e.g., email, username). Must match the corresponding principal field in the profile object.
password	String	The password for the new location.

JSON

{
  "profile": {
    "name": "Juan Perez SRL",
    "cuit": 2147483648,
    "email": "[email protected]",
    "cellphone": {
      "intCode": "54",
      "areaCode": "11",
      "number": "123123124"
    },
    "address": {
      "countryId": 1,
      "stateId": 1,
      "city": "Rio Chico"
    }
  },
  "optIns": [],
  "ownerPartnerPrincipal": "12345678",
  "credential": {
    "principal": "[email protected]",
    "password": "user_password"
  }
}

---

Response

✅ Successful Response: 201 Created

The physical location was successfully created and logged in. The response returns the new session context.

JSON

{
  "context": {
    "links": [
      {
        "ref": "home",
        "href": "/api/v4/people/home"
      }
    ],
    "activities": [],
    "simpleProfile": {
      "email": "[email protected]",
      "me": false
    }
  }
}

❌ Unsuccessful Response: 400 Bad Request

Returned if the request fails validation. See below for common error examples.

Scenario: Field Validation Error

JSON

{
  "errors": {
    "code": "InvalidId",
    "message": "Invalid ID",
    "field": "profile.address.countryId"
  }
}

Scenario: Credential Already Exists

JSON

{
  "errors": {
    "code": "error.invalid.credentials",
    "message": "The following credential already exists: email"
  }
}

Scenario: Invalid Partner Principal

JSON

{
  "errors": {
    "code": "Not a Partner",
    "message": "Not a Partner",
    "field": "ownerPartnerPrincipal"
  }
}