Skip to content

create

PUT
/waypoint

Creates a waypoint.

Authorizations

Parameters

Query Parameters

requestKey
string

Unique request id. Prevents auto cancel when sending multiple requests.

Request Body

object
name
string
description
string
lat
required
number
>= -90 <= 90
lon
required
number
>= -180 <= 180
icon
string
author
required

User Id

string
>= 15 characters <= 15 characters
Example
{
"name": "non repellat possimus",
"description": "Impedit modi nisi quibusdam eum rerum illo. Minus mollitia delectus vitae optio vero. Maiores praesentium dolores nostrum laborum saepe. Dolorem qui non. Dolorem dolores facere facere reiciendis ab doloribus.",
"lat": -81.44545573482735,
"lon": 178.9999004930424,
"icon": "pen",
"author": "3mugf953w4a9fg5"
}

Responses

200

object
author
required
string
collectionId
required
string
collectionName
required
string
created
required
string
description
required
string
icon
required
string
id
required
string
lat
required
number
lon
required
number
name
required
string
photos
required
Array<string>
updated
required
string
Examples

Success

{
"author": "3mugf953w4a9fg5",
"collectionId": "goeo2ubp103rzp9",
"collectionName": "waypoints",
"created": "2025-01-03 13:07:25.852Z",
"description": "Impedit modi nisi quibusdam eum rerum illo. Minus mollitia delectus vitae optio vero. Maiores praesentium dolores nostrum laborum saepe. Dolorem qui non. Dolorem dolores facere facere reiciendis ab doloribus.",
"icon": "pen",
"id": "fjqcwd17fawiy83",
"lat": -81.44545573482735,
"lon": 178.9999004930424,
"name": "non repellat possimus",
"photos": [],
"updated": "2025-01-03 13:07:25.852Z"
}

400

object
message
required
string
detail
required
object
code
required
integer
message
required
string
data
required
object
author
required
object
code
required
string
message
required
string
Examples

Exception

{
"message": "Failed to create record.",
"detail": {
"code": 400,
"message": "Failed to create record.",
"data": {
"author": {
"code": "validation_missing_rel_records",
"message": "Failed to find all relation records with the provided ids."
}
}
}
}

x-400:Invalid Params

object
message
required
string
detail
required
Array<object>
object
code
string
expected
string
received
string
path
Array<string>
message
string
Examples

Exception

{
"message": "invalid_params",
"detail": [
{
"code": "invalid_type",
"expected": "string",
"received": "number",
"path": [
"text"
],
"message": "Expected string, received number"
}
]
}