DocumentationAPI Reference
DocumentationAPI Reference

Inquiry Fields

Inquiries store values collected from the user in fields. Every template has a field schema representing all the information is collected in an inquiry flow.

You can configure custom fields on your template field schema to support your use cases. Please contact support or your CSM to get started.

Field types

Every field can store a single type of value.

Name

Format

boolean

true | false

date

'YYYY-MM-DD'

float

123.45

integer

123

string

'hello world'

Reading fields

An inquiry's fields can be retrieved via the external API using a GET request. Fields are also passed back to the caller in inquiry flows on completion.

Fields are serialized as a nested map of field name to field type and field value. For example:

{
  "name-first": {
    "type": "string",
    "value": "John",
  },
  "name-first": {
    "type": "string",
    "value": "Doe",
  },
  "birthdate": {
    "type": "date",
    "value": "1980-12-25",
  }
}

Writing fields via API

When updating an inquiry via API, fields should be passed as a map of field name to field value. Field type does not need to be specified.

{
  "name-first": "John",
  "name-first": "Doe",
  "birthdate": "1980-12-25"
}