POST   private-location/create

Creates a new private location for the current customer.

Remarks

Use Country Details route to get the list of Country object having values applicable for Country, State, City.
The Name and City field in the request body must only contain alphanumeric characters and hyphens (-) with no spaces. Any other characters will result in an "Invalid input" error.

Request example and description

curl --request POST "https://api-asm1.apica.io/v3/private-location/create?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
  \"Enabled\": true,
  \"Name\": \"sample-string\",
  \"Country\": \"Sweden\",
  \"State\": \"NA\",
  \"City\": \"sample-string\"
}"
NameType Required Description
Enabled Boolean No

Indicates whether the private location is enabled.
Name String Yes

The name of the private location.
Country String Yes

The country of the private location.
State String No

The state of the private location.
City String Yes

The city of the private location.

Response body model example and description

{
  "private_location_id": "e8ac354b-0c7d-4c8a-b167-fc43d0b8d477",
  "enabled": true,
  "geoloc": "sample string 3",
  "customer_guid": "6b5d94e0-3564-41d1-b11b-d64107ba3f2c"
}
NameType Description
PrivateLocationId Guid

Unique identifier for the private location.
Enabled Boolean

Indicates whether the private location is enabled.
Geoloc String

Geographical location of the private location.
CustomerGuid Guid

Customer identifier associated with the private location.