Skip to content

Create Label

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

Create a floating text label on a map.

map_id
required
Map Id
string
MapLabelCreate
object
text
required
Text
string
>= 1 characters <= 200 characters
xPct
required
Xpct
number
<= 100
yPct
required
Ypct
number
<= 100
fontSize
Fontsize
number
default: 16 >= 8 <= 72
color
Color
string
default: #ece8e2 /^#[0-9a-fA-F]{6}$/
rotation
Rotation
number
0 >= -180 <= 180
fontStyle
Fontstyle
string
default: normal
letterSpacing
Letterspacing
number
0 <= 20
minZoom
Minzoom
number
0
maxZoom
Maxzoom
number
default: 100

Successful Response

MapLabelResponse
object
id
required
Id
string
mapId
required
Mapid
string
projectId
required
Projectid
string
text
required
Text
string
xPct
required
Xpct
number
yPct
required
Ypct
number
fontSize
required
Fontsize
number
color
required
Color
string
rotation
required
Rotation
number
fontStyle
required
Fontstyle
string
letterSpacing
required
Letterspacing
number
minZoom
required
Minzoom
number
maxZoom
required
Maxzoom
number
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer

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