Skip to main content
POST
/
v1
/
public
/
properties
/
{object_name}
Create Property
curl --request POST \
  --url https://api.sanka.com/v1/public/properties/{object_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "internal_name": "<string>",
  "type": "<string>",
  "description": "<string>",
  "number_format": "<string>",
  "choice_values": {},
  "conditional_choice_mapping": {},
  "tag_values": [
    "<string>"
  ],
  "unique": true,
  "required_field": true,
  "multiple_select": true,
  "show_badge": true,
  "badge_color": "<string>",
  "order": 123
}
'
{
  "ok": true,
  "status": "<string>",
  "object": "<string>",
  "property_id": "<string>",
  "ctx_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

object_name
string
required

Body

application/json
name
string | null
internal_name
string | null
type
string | null
description
string | null
number_format
string | null
choice_values
conditional_choice_mapping
Conditional Choice Mapping · object
tag_values
string[] | null
unique
boolean | null
required_field
boolean | null
multiple_select
boolean | null
show_badge
boolean | null
badge_color
string | null
order
integer | null

Response

OK

ok
boolean
required
status
string
required
object
string
required
property_id
string
required
ctx_id
string
required