Create a Custom Field

Create a new contract custom field in your SysAid account. Requires System Admin permissions.

Body Params

The payload to create a contract custom field. Requires System Admin permissions.

string
required
length between 3 and 64

The custom field's display name. Must be 3 to 64 characters, and unique within the account (case-insensitive).

string
enum
required

The data type of a contract custom field, which determines the value format expected in a contract's "customFields" map:

  • "short-text": a single-line free-text value (maximum 100 characters).
  • "long-text": a multi-line free-text value (maximum 500 characters).
  • "number": a numeric value that may include decimals.
  • "date": a calendar date in ISO 8601 format ("YYYY-MM-DD").
  • "list": a single-select field that returns the ID of the chosen option from the field's "values" map.
Allowed:
values
array of strings
length between 1 and 50

The option labels for a "list" field. Required for "list" fields and forbidden for all other types. Provide 1 to 50 labels; the server assigns each option an ID.

values
Responses

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