Data fields are contract variables (also known as placeholders, custom fields, tags, etc.) that you can use in contract product tables, text and image, and form sections.

You can set the values for the data fields in a contract or at the template type level. The behavior of these two operations is different, so it is important to understand the difference. Please, see the Create a contract with data fields tutorial for more information.

Data field attributes

The table below displays all the attributes available for each data field:

Attribute	Type	Description
_links	object	Contains links to endpoints associated with this data field. See Data fields links.
active	boolean	Indicates whether the data field is active. Note: Only active data fields can be used in a contract or template.
custom_id	string	A custom identifier you can use to address the data field through the API. Each `custom_id` must be unique within the same template type.
description	string	The description of the data field.
id	integer(signed_integer_id)	The ID of the data field.
name	string	A short descriptive name for the data field.
placeholder	string	Placeholder text displayed in the data field UI when the value is absent.
source	string(enum)	Indicates the source of the data field. See Source.
value	string	The value of the data field. Text values are limited to 1024 characters. If the data field's type is a checkbox, then the value can be 0 (false) or 1 (true). See Value.

Data fields links

The _links object contains links to the endpoints associated with the data fields.

Attribute	Type	Description
template_type	object	The link to the `Get template type` endpoint. See Links.

Source

Source	Description
user	Indicates that the data field was created by a user either via the API or via the Oneflow application.
system	Indicates that the data field was created and is used by one of the integration extensions.

❗️
Note:
Data fields where source=system cannot be updated. An attempt to update such data fields will return a 200 OK response, but the attribute will not be updated.

Value

Input type	Description
checkbox	If the data field attribute value is `0`, it is considered `false`, and the checkbox will be displayed as unchecked. If the data field attribute value is `1`, it is considered `true`, and the checkbox will be displayed as checked.