get
https://api.marketcircle.net/v1/form_definitions/
Get the information of a form definitions
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Attributes
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the Form Definition | Read-only Non-null |
name | string | The name of the form definition | Read-Write Non-null Required |
description | string | Description of the form definition | Read-Write Nullable |
is_active | boolean | Whether new forms can be made from this definition | Read-Write Non-null Default value is true |
entities | array of string | The types of record forms can be added to, e.g. ["Contact", "Project"]. Send lowercase names: contact, company, opportunity, project, task, appointment, group, note, email | Read-Write Nullable |
key_definitions | array of field | The fields on the form (max 64). See Fields | Read-Write Nullable |
trashed | boolean | Whether the definition is in the trash. Set to false to restore it | Read-only Non-null |
create_date | datetime | When the form definition was created | Read-only Non-null |
Fields
Each entry in key_definitions describes one field:
{ "name": "Areas checked", "type": "multiple_checkboxes", "options": ["Roof", "Basement", "Wiring"], "default": "Roof" }| Key | Description |
|---|---|
name | Field name (max 256 characters). Forms refer to the field by this name |
type | One of the types below. Required |
description | Description of the field |
options | Option names, for option, combo and multiple_checkboxes fields |
default | Default value; for option fields, the name of the default option |
type | Daylite field type | Value on a form |
|---|---|---|
text | Text | value: string |
number | Number | value: integer |
float | Decimal Number | value: number |
money | Currency | value: number |
date | Date | value: date-time string |
time | Time | value: date-time string |
date_time | Date & Time | value: date-time string |
checkbox | Checkbox | value: 1 or 0 |
option | Popup Options | values: array with one option name |
combo | Combo Box Options | values: array of option names |
multiple_checkboxes | Multiple Checkboxes | values: array of option names |
When updating a definition, a key_definitions array replaces the fields it names and adds any new ones. To remove a field, send {"key_definitions": {"remove": [{"name": "Rating"}]}}.