Set or clear this user's home location

PUT

/api/v1/profile/home

curl --request PUT \
  --url http://localhost:11044/api/v1/profile/home \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "label": "example", "latitude": 1, "longitude": 1 }'

• Your world, at the port the installer gives it

Authorizations

• apiKeyAuth
• basicAuth

Request Body^required

The home location, replacing any stored one. latitude and longitude are decimal degrees; a blank label becomes home. No coordinates and no label other than home clears the home location instead

Media typeapplication/json

A home location to set, the body of PUT /profile/home. No coordinates and no label other than home clears it

object

label

Human-readable label; absent or blank means home

string

latitude

WGS84 latitude in decimal degrees; absent or null when unknown

number format: double

longitude

WGS84 longitude in decimal degrees; absent or null when unknown

number format: double

Example ^generated

{
  "label": "example",
  "latitude": 1,
  "longitude": 1
}

Responses

200

OK

Media type*/*

The signed-in user’s display name and home location, answered by GET /profile and by the profile writes

object

displayName

required

The name the assistant uses for this user. Never null: until a name is set it falls back to the account’s id

string

home

Home location, or null when none is set

object

label

Human-readable label, e.g. home

string

latitude

WGS84 latitude in decimal degrees, or null when only a label is known

number format: double

longitude

WGS84 longitude in decimal degrees, or null when only a label is known

number format: double