Unifize Knowledge Base
  • Quickstart
    • Welcome to Unifize!
  • Getting started
    • Setting up your Unifize account
      • Signing up with invite link
      • Logging in with email
    • Quickstart demo
    • Key features & navigation
      • Records
      • Conversations
      • Checklists
    • First steps for new users
      • Creating a new record
      • Creating records from inbound email
      • Filling checklist metadata
      • Linking related records
      • Sharing conversations as email
      • Sending and receiving emails in Unifize
      • Inviting people
      • Changing your preferred language
      • Filtering records in My Inbox
      • Generating PDF reports
      • Creating custom reports
      • Creating custom dashboards
    • Using Unifize AI
  • Troubleshooting & support guide
  • User Guide
    • Definitions
      • Process
      • Record
      • Conversation
      • Report
      • Chart
      • Checklist
      • Org
    • Navigating the platform
      • Profile
      • My Inbox
      • Manage
      • Homescreen
      • Contacts
      • Direct Messages
      • Dashboard
    • Data & process management
      • File Management
      • Checklists & Forms
      • Rich text in checklist
      • Working with records
        • Due dates & priorities of a record
    • User & role management
      • Understanding roles & access
      • Managing permissions
      • Deactivating users
      • Team & organization
    • Mobile & web accessibility
      • Unifize Lite
      • Mobile app
      • Web app vs Unifize Lite
    • Security, compliance & infrastructure
    • Personalizations
      • Set your profile picture
      • Reset your Passwords
      • Customizing Homescreen
      • Set your email notification preferences
    • File upload
      • SharePoint
        • Configuring SharePoint on Unifize
        • Using SharePoint on Unifize
    • SSO
      • Logging in with SSO
      • SSO using SAML
    • Process Builder
      • Checklist
        • Picklist
          • Picklist field in Checklist
  • Product Help
    • Unifize Document Management System (DMS)
      • Document Control
      • Change Control
      • Training Management
      • Onboarding guide for DMS
      • Troubleshooting & support guide for DMS
  • Admin Guide
    • Multi-language translation support
      • Enabling and configuring language support
      • Managing user language preferences at scale
      • Using the translation editor to customize UI
    • Customization & configuration
      • Configuring processes
      • Configuring revision fields
      • Configuring approval workflows
      • Configuring reminders on processes
      • Checklist layout settings
      • Custom language settings
      • Creating a chart from reports
      • Configuring Microsoft Office 365
        • Permissions required for SharePoint
  • Developer Documentation
    • Introduction
      • Concepts & terminologies
    • Authentication
      • App management
      • App tokens
    • Usage
      • Fair usage policy
      • Testing environment
      • Quickstart
    • API Reference
      • Applications
      • Processes
      • Records
      • Field values
  • RELEASE NOTES
    • February 2025
    • March 2025
    • April 2025
      • Rich Text Fields in Checklist
      • Filling Checklist Metadata with AI
      • 'My Conversations' is now 'My Inbox'
      • Feature Enhancements
Powered by GitBook
On this page
Export as PDF
  1. Developer Documentation
  2. API Reference

Field values

PreviousRecordsNextFebruary 2025

Last updated 1 month ago

Examples

The examples below will take you through filling in the checklist of your record, for all kinds of checklists fields.

Text field

Filling text

The value attribute is a plaintext string.

{
    "value": "Some text"
}

Modifying text

Follow the same instructions as #adding-text to overwrite existing text.

Clear text

{
    "value": ""
}

Number field

Filling a number

The value attribute is a numerical value.

{
    "value": 10
}

Updating number

Follow the same instructions as Filling a number to overwrite the existing number.

Clearing number

{
    "value": null
}

Picklist field

Filling an option

The value attribute is either a string or an array of strings.

{
    "value": ["abc","xyz"]
}

Deleting option

Follow the same instructions as Filling an option to overwrite the existing option(s).

Clearing options

{
    "value": null
}

Date field

Filling a date

The value attribute is a date as a string, in the format yyyy-mm-dd.

{
    "value": "1999-12-15"
}

Updating date

Follow the same instructions as Filling a date to overwrite the existing date.

Clearing date

{
    "value": null
}

User field

Filling a user/group

{
  "value": [
    {
      "type": "user",
      "uid": "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
    },
    {
      "id": 1098,
      "type": "group"
    }
  ]
}
{
  "value": {
    "id": 2000,
    "type": "group"
  }
}

Deleting a user/group

{
  "value": {
    "id": 1098,
    "type": "group"
  }
}

File field

Attaching a file

You must first upload your file using the Upload file API. Then, you can attach it to the checklist using the file id and version id.

{
  "value": {
    "name": "a4e0580a-a7dd-469f-a373-a852e9efb684",
    "versionId": "7Pq5poXyVwHTJAzaEwS7ZYj9FdEXzkSi",
    "size": 124243,
    "originalName": "1280px-Giant_Panda_2.jpg",
    "folderId": null
  }
}

Removing file(s)

{
  "value": []
}
{
  "value": "a4e0580a-a7dd-469f-a373-a852e9efb684"
}

PDF field

Revision field

  • A comment (revision notes)

  • Data to copy over

    • Metadata

    • Checklist field values

{
  "value": {
    "comment": "abc",
    "clone": {
      "metadata": [
        "title",
        "owner",
        "members",
        "dueDate",
        "files",
        "messages"
      ],
      "checklistFields": [
        340441,
        341220,
        341221,
        341222
      ]
    }
  }
}

Approval field

Requesting an Approval (Adhoc)

{
  "value": {
    "requestApproval": true,
    "config": {
      "approvers": {
        "groups": [],
        "users": [
          "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
        ]
      },
      "minApprovers": 1
    }
  }
}

Signing an Approval

  • Whether to use a custom signature or the default one

  • Whether to approve or reject

  • A comment

  • Your email and password

{
  "value": {
    "customSignature": true,
    "approved": true,
    "comment": "abc",
    "username": "abc@unifize.com",
    "password": "password"
  }
}

Canceling an Approval

{
  "value": {
    "revision": true,
    "comment": "abc"
  }
}

Conversation field (Parent/Child)

Create new record

{
  "value": {
    "title": "abc",
    "type": "workflow",
    "owner": "jA6d4gH0oMfGd90uKCrFyjMnrvt2",
    "creator": "jA6d4gH0oMfGd90uKCrFyjMnrvt2",
    "members": [
      "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
    ],
    "templateId": 16650,
    "description": "",
    "orgId": 222,
    "groups": [],
    "parent": 1453392,
    "numberingScheme": "API Docs Conv ###",
    "checklists": [],
    "privacy": "none"
  }
}

To add more values, the same API can be used. It will not overwrite existing values.

Select existing record

{
  "value": [
    1453412,
    1453413
  ]
}
{
  "value": 1453413
}

Delete conversation

{
  "value": []
}
{
  "value": 1453413
}

Linked field

Create new record

{
  "value": {
    "chatroom": {
      "title": "abc",
      "type": "workflow",
      "owner": "jA6d4gH0oMfGd90uKCrFyjMnrvt2",
      "creator": "jA6d4gH0oMfGd90uKCrFyjMnrvt2",
      "members": [
        "jA6d4gH0oMfGd90uKCrFyjMnrvt2"
      ],
      "templateId": 16650,
      "description": "",
      "orgId": 222,
      "groups": [],
      "parent": 1453392,
      "numberingScheme": "API Docs Conv ###",
      "checklists": [],
      "privacy": "none"
    }
  },
  "linkAllVersions": true
}

Select existing record

{
  "value": [
    {
      "chatroom": 1453412, 
      "linkAllVersions" true
    },
    { 
      "chatroom": 1453413, 
      "linkAllVersions" true
    }
  ]
}
{
  "value": {
    "chatroom": 1453413, 
    "linkAllVersions" true
  }
}

Linking specific record revisions

If you set linkAllVersions to true in Create new recordand Select existing record, all of the revisions of the linked record will also be automatically linked.

To link only a specific revision, you can remove that attribute from the payload.

Delete record

{
  "value": {
    "originChatroomId": 1453413
  }
}

Form field

Creating a form instance

{
  "value": {
    "templateId": 18585
  }
}

Filling/updating/deleting a field value inside a form

See the above examples on how to fill the different types of fields.

Filling them when they are inside a form is exactly the same, but you will need to specify the formId query parameter when calling any of the APIs.

  • templateId This is the ID of the form template. It will remain constant throughout the form instances, across chatrooms. This is the ID you should use when creating a form instance.

  • id This is the ID of the unique, individual form instance. This is the ID you should use when filling a field inside a form.

Deleting a form instance

{
  "value": 235224
}

Use the API.

To clear all text, use the API and set the value attribute to an empty string.

Use the API.

To delete the number, use the API and set the value attribute to null.

Use the API.

To delete all the options, use the API and set the value attribute to [] or null.

Use the API.

To delete the date, use the API and set the value attribute to null.

Use the API. The value attribute is a JSON object or an array of JSON objects, representing either a user or a group.

Alternatively, you can use the API and specify a single user or group instead of all of them. This will effectively append a value to the existing values instead of overwriting them.

Use the API. The value attribute is a JSON object representing the user or group you wish to delete

Use the API.

Use the API and set the value attribute to [] or null to delete all the files from the checklist field.

Alternatively, use the API to delete a single file from the checklist field.

Use the API. You do not need to send anything in the payload to generate the PDF.

Use the API. When creating a revision, you can specify the following options:

Use the API. When requesting an approval, you can specify users and groups that can sign the approval.

Use the API. When signing, you can specify the following options:

Use the API and set the revision attribute to true.

Use the API. The value attribute would match the payload used in the API.

Use the API. The value attribute is an array of record ID's. This will overwrite any existing records present in the field.

Alternatively, you can use the API and specify a single record ID. This will "append" a value to the existing values, without overwriting them.

To delete all the values, use the API and set the value attribute to null or [].

To delete a single value, use the API and specify the value to be deleted in the payload.

Use the API. The value attribute would match the payload used in the API.

Use the API. The value attribute is an array of objects. This will overwrite any existing records present in the field.

Alternatively, you can use the API and specify a single record ID. This will "append" a value to the existing values, without overwriting them.

To delete a single value, use the API and specify the value to be deleted in the payload.

Use the API and specify the form template id.

The responses of and APIs for a form field will include two identifiers which might be confusing to distinguish.

Use the API and specify the form instance ID in the payload.

Create field value
Create field value
Create field value
Create field value
Create field value
Create field value
Create field value
Create field value
Create field value
Update field value
Delete field value
Update field value
Create field value
Delete field value
Create field value
Create field value
Create field value
Create field value
Create field value
Create field value
Update field value
Create field value
Delete field value
Create field value
Update field value
Delete field value
Update field value
Update field value
Get field value
Delete field value
Create field value
Update field value
Create record
Create record

Delete field value

delete
Path parameters
idintegerRequired

ID of the record

Example: 25
fidintegerRequired

Field ID

Example: 3
Responses
204
No Content
delete
DELETE /chatroom/{id}/checklist-field/{fid}/value HTTP/1.1
Host: 
Accept: */*
204

No Content

No content

  • GETGet field value
  • POSTCreate field value
  • PATCHUpdate field value
  • DELETEDelete field value
  • Examples
  • Text field
  • Number field
  • Picklist field
  • Date field
  • User field
  • File field
  • PDF field
  • Revision field
  • Approval field
  • Conversation field (Parent/Child)
  • Linked field
  • Form field

Get field value

get
Path parameters
idintegerRequired

ID of the chatroom

Example: 25
fidintegerRequired

ID of the checklist field

Example: 3
Responses
200
Success
application/json
get
GET /chatroom/{id}/checklist-field/{fid} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "fieldId": 25,
  "fieldType": "text",
  "attrs": "{\"~#text\":{\"label\":\"Any text\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
  "target": false,
  "type": "{\"~#text\":{\"label\":\"Any text\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
  "chatroomId": 91,
  "val": {
    "value": "Quantity",
    "type": "text"
  },
  "value": "Quantity"
}

Create field value

post
Path parameters
idintegerRequired

ID of the record

Example: 25
fidintegerRequired

Field ID

Example: 3
Body
valueanyRequired

Value

Example: 22
checkedbooleanOptional

Boolean indicating if the field is checked

Example: true
Responses
200
Success
application/json
post
POST /chatroom/{id}/checklist-field/{fid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "value": 22,
  "checked": true
}
200

Success

{
  "fieldId": 25,
  "fieldType": "text",
  "attrs": "{\"~#text\":{\"label\":\"Any text\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
  "target": false,
  "type": "{\"~#text\":{\"label\":\"Any text\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
  "chatroomId": 91,
  "val": {
    "value": "Quantity",
    "type": "text"
  },
  "value": "Quantity"
}

Update field value

patch
Path parameters
idintegerRequired

ID of the record

Example: 25
fidintegerRequired

Field ID

Example: 3
Body
valueanyRequired

Value

Example: 22
checkedbooleanOptional

Boolean indicating if the field is checked

Example: true
Responses
200
Success
application/json
patch
PATCH /chatroom/{id}/checklist-field/{fid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "value": 22,
  "checked": true
}
200

Success

{
  "fieldId": 25,
  "fieldType": "text",
  "attrs": "{\"~#text\":{\"label\":\"Any text\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
  "target": false,
  "type": "{\"~#text\":{\"label\":\"Any text\",\"autoCheck\":false,\"settings\":\"{\\\"multiline\\\":true}\"}}",
  "chatroomId": 91,
  "val": {
    "value": "Quantity",
    "type": "text"
  },
  "value": "Quantity"
}