Custom fields are where you can either supply extra information to workers in the field or prompt them to collect information when they are completing the job.
Every custom field has a name, type, value, and permission.
You cannot have two custom fields within a job with the same name.
There are 11 different custom field types. A custom field type defines the type of data expected. (eg: text, photo, signature, etc.) The type of custom field will determine what values you can add. (eg: you cannot add a photo to a text field.)
Each custom field has a permission associated with it that determines how it is displayed to the mobile worker (eg: hidden, optional, mandatory, etc.)
A full list of custom field types, permissions, as well as some samples are listed below.
| Name | Type | Description |
|---|---|---|
| text | String | Allows users to enter text into the custom field. (this is the default, unless you specify a different type) |
| image | String | Creates a custom field for a dispatcher or worker to upload an image. (Images cannot be uploaded via the API, but links to images uploaded via the website or mobile apps are available to download via the attachments API call.) |
| datetime | DateTime | Shows a date-time picker to make it easier for users to enter a date and time. The format of the date/time must be ISO8601 as per the tech note. |
| number | String | This field can only contain numbers, plus the minus and decimal place characters. The custom field input on the device will show a number keypad layout. |
| link | String | Creates a clickable URL field. URLs must begin with http:// or https:// and should be a valid URL. |
| checkbox | String | Creates a check box field where the value must be true or false. Accepted values for true include '1','true','t','checked' and 'on'. |
| currency | Decimal | Creates a numerical decimal field. This field can only contain numbers, plus the minus and decimal place characters. |
| signature | String | Creates a custom field for a worker to collect a signature. Please note, this is in addition to the default proof of delivery signature that appears on every job by default. (Signatures cannot be uploaded via the API, but links to signatures uploaded from the mobile apps are available to download via the signatures API call.) |
| pick_list | String | Uses an existing pick list from the account, users can choose one of the pre-defined values. (Pick lists can be administered via the pick lists api call.) |
| multi_pick_list | String | Uses an existing pick list from the account, users can choose more than one of the pre-defined values. (Pick lists can be administered via the pick lists api call.) |
| location | Two Decimals and a String | Creates a location custom field. This field may contain a lat/long as well as a free text string that describes the location. This string is often (but not always) a street address. There is an example of the format in the custom field samples section below. |