Fields

Add Field

Required scopes: field (Read and Write).

post/fields

Request

Request body

namestring required

Field name

slugstring required

Field slug

type'checkbox' | 'radiobuttons' | 'date' | 'datetime' | 'number' | 'labels' | 'select' | 'multiselect' | 'text' | 'textarea' | 'url' required

Field type

descriptionstring

Field description

entitiesstring[] required

Entities that will be associated with field

Example request

{
  "name": "Client company",
  "slug": "client-company",
  "type": "select",
  "description": "Client company field is appointed to store info about client company",
  "entities": [
    "task"
  ]
}

Response

Field was successfully created

Example response

{
  "data": {
    "id": 2,
    "name": "Custom field",
    "slug": "custom-field",
    "description": "Custom field description",
    "type": "select",
    "entities": [
      "task"
    ],
    "createdAt": "2019-09-23T09:04:29+00:00",
    "updatedAt": "2019-09-23T09:04:29+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.