Sign in

v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
CustomFields

Update a custom field already created

Update a custom field. If fieldtype is "select" and options is not sent, it will get its past options. 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

patch/position/custom-fields

Request body

titlestring

Title of the field

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

Typeof field you want to edit into. If fieldtype is "select" and options is not sent, it will get its past options. 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

propertyIdstring required

Internal property id

Example request

{
  "title": "Local de trabalho",
  "fieldType": "text",
  "options": [
    "P",
    "M",
    "G"
  ],
  "isIntegrated": true,
  "propertyId": "d50144bb-9cfc-4770-b8ae-da5c5c8ac036"
}

Response

Successful operation

idnumber
companyIdnumber