Skip to content
Ishvana Ishvana Docs

Create Pin

POST
/api/creative/lore/maps/{map_id}/pins

Create a pin on a map.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
map_id
required
Map Id
string

Request Body required

Section titled “Request Body required ”
MapPinCreate
object
label
Label
string
"" <= 200 characters
xPct
required
Xpct
number
<= 100
yPct
required
Ypct
number
<= 100
icon
Icon
string
default: map-pin <= 50 characters
color
Color
string
default: #d4885c /^#[0-9a-fA-F]{6}$/
size
PinSize
string
default: medium
Allowed values: small medium large
legendCategoryId
Any of:
string
loreEntryId
Any of:
string
linkedMapId
Any of:
string
notes
Notes
string
"" <= 5000 characters
minZoom
Minzoom
number
0
maxZoom
Maxzoom
number
default: 100

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

MapPinResponse
object
id
required
Id
string
mapId
required
Mapid
string
projectId
required
Projectid
string
label
required
Label
string
xPct
required
Xpct
number
yPct
required
Ypct
number
icon
required
Icon
string
color
required
Color
string
size
required
Size
string
legendCategoryId
Any of:
string
loreEntryId
Any of:
string
loreEntryTitle
Any of:
string
loreEntryType
Any of:
string
linkedMapId
Any of:
string
linkedMapTitle
Any of:
string
notes
required
Notes
string
minZoom
required
Minzoom
number
maxZoom
required
Maxzoom
number
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object