Skip to main content
POST
/
{version}
/
users
/
{user}
/
fields
Create field
curl --request POST \
  --url https://api.perscom.io/{version}/users/{user}/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "key": "<string>",
  "type": "<string>",
  "cast": "<string>",
  "description": "<string>",
  "placeholder": "<string>",
  "default": "<string>",
  "help": "<string>",
  "required": true,
  "rules": "<string>",
  "readonly": true,
  "hidden": true,
  "options": [
    {}
  ],
  "options_type": "array",
  "options_model": "<string>"
}'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "key": "<string>",
    "type": "<string>",
    "cast": "<string>",
    "description": "<string>",
    "placeholder": "<string>",
    "default": "<string>",
    "help": "<string>",
    "required": true,
    "rules": "<string>",
    "readonly": true,
    "hidden": true,
    "options": [
      {}
    ],
    "options_type": "array",
    "options_model": "<string>",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
​
user
integer
required

Body

application/json
​
name
string
​
key
string | null
​
type
string
​
cast
string | null
​
description
string | null

Supports HTML.

​
placeholder
string | null
​
default
string | null
​
help
string | null
​
required
boolean
​
rules
string | null
​
readonly
boolean
​
hidden
boolean
​
options
object[]
​
options_type
enum<string>
Available options:
array,
model
​
options_model
string

If the options type is a model, this is the resource that should populate the options field.

Response

OK

​
data
object