Skip to content
Docs
Select language:English

/api/v1/place-kinds/{id}/fields

POST
/api/v1/place-kinds/{id}/fields
curl --request POST \
  --url https://example.com/api/v1/place-kinds/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fields \
  --header 'Content-Type: application/json' \
  --data '{ "key": "example", "label": "example", "kind": "text", "unit": "example", "options": [ "example" ], "repeatable": true, "required": true, "secret": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
key
required
string
/^[a-z][a-z0-9_]{0,39}$/
label
required
string
>= 1 characters <= 80 characters
kind
required
string
Allowed values: text number date select multi_select boolean url money person vendor file
unit
string
>= 1 characters <= 12 characters
options
Array<string>
<= 100 items
repeatable
boolean
required
boolean
secret
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
key
required
string
label
required
string | null
labelKey
required
string | null
kind
required
string
Allowed values: text number date select multi_select boolean url money person vendor file
unit
required
string | null
options
required
Any of:
Array<string>
repeatable
required
boolean
required
required
boolean
secret
required
boolean
sort
required
integer
>= -9007199254740991 <= 9007199254740991
archivedAt
required
string | null
source
required
object
typeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
via
required
string
Allowed values: own inherited group
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "kind": "text",
  "source": {
    "via": "own"
  }
}