Sign in

v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
CustomFields

Create a new custom field

Create a new custom field. If fieldType is "select", "options" value needs to be sent. Also, it can not exist more than one location field of the same type, example: two fields of type cities, two fields of type states, two fields of type countries

post/position/custom-fields

Request body

titlestring required

Title of the field

fieldType'text' | 'select' | 'number' | 'boolean' | 'date' | 'cities' | 'states' | 'countries' | 'customFieldFile' required

Typeof field you want to create. If fieldtype is "select", options must be sent. Also, it is not possible to exist more than one location field of the same type (example: two fields of "cities" type)

optionsstring[]

Options to be selected when fieldType is "select"

isRequiredboolean

Decides whether the field is mandatory or not

isIntegratedboolean

Decides whether the field should be integrated or not

Example request

{
  "title": "Local de trabalho",
  "fieldType": "text",
  "options": [
    "P",
    "M",
    "G"
  ],
  "isIntegrated": true
}

Response

Successful operation

idnumber
companyIdnumber