GuidesAPI ReferenceDiscussions
API Reference

Create or Update a Custom Field.

post
https://api.servicem8.com/custom_fields_1.0

Creating and updating are identical, except that you must specify a uuid when updating an existing Custom Field. When creating a new Custom Field, the UUID will be returned in the JSON response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Custom Field to be created or updated

uuid

Unique identifier for this Custom Field. Required if updating an existing Custom Field.

string
enum
required

Indicates the object type that this custom field applies to.

Allowed:
uuid

Indicates the object uuid when specifying a Badge custom field. Required when object type is Badge, not required otherwise.

string
required

Indicates the field name to represent this custom field. This will become available via the REST API for GET/POST requests for the given account.

string
required

The name of the custom field displayed to users.

boolean

True if values entered into this Custom Field should be enforced as unique between different records.

integer
1 to 2000

The maximum length of this field.

integer
0 to 100

Controls the order of this custom field, as a percentage against other custom fields.

string
enum
required

The type of input data this custom field will accept. See Field Types for options.

Allowed:
select_list_items
array of strings

An array of user visible select list options to select from for use with the field type SelectList. Required when field type is SelectList, not required otherwise.

select_list_items
Responses

Updated about 1 year ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago