Risk Cloud API: Update Records

Updated on: April 05, 2024

Updating records is an essential capability in the Risk Cloud, and with Risk Cloud’s Record API, you can update the values of Risk Cloud records via the Risk Cloud API.

Obtain your API Access Token or pull the Risk Cloud Postman Collection to get started.

Update Records Endpoint

The Record API offers the following Update Records endpoint which updates the values a given record.

The Update Records endpoint requires that the user whose API token is being used for the request is entitled with Write access to the given record.

PATCH/api/v1/records/{record-id}

This endpoint has the following request body properties.

[
  {
    "fieldId": "e5f6g7h8",
    "values": [
      "The string value of the field"
    ]
  }
]
Query Parameter Requiredness Description
fieldId optional The unique ID of the field to set the values to on the given record.
values optional An array of strings representing the text values to set to the fields of the corresponding field IDs on the given record.

Resources

Get Record ID

The record-id can be obtained from the Risk Cloud web application, emails, or via the Risk Cloud API.

Using the Risk Cloud application

The most straightforward way to find the record ID for record-id is to open the desired record in the Risk Cloud web application, then take the ID from the end of the URL.

https://your-company.logicgate.com/records/{record-id}

Expected Values for Field Types

Different field types expect different value formats. Below are the common field types and the expected string formats for the values array:

  • Text Fields:

    Example: "Sample text"

    Text fields expect a single string value.

  • User Fields:

    Example: "[email protected]"

    User fields expect the user's email address as a string.

  • Date Fields:

    Example: "2023-12-31"

    Date fields expect a date in the YYYY-MM-DD format.

  • Number Fields:

    Example: "12345.67"

    Number fields expect a numeric value as a string. This can include integers or decimals based on the field's configuration. For example, a field with the DECIMAL format will accept values like "12345.67".

  • Select + Multi Select Fields:

    Example: "Option1"

    Select and Multi Select fields expect the selected option as a string.

  • Checkbox Fields:

    Example: "true" or "false"

    Checkbox fields expect a boolean value as a string ("true" or "false").

  • Attachments:

    Attachments require separate addition via the endpoints highlighted in the Risk Cloud API: Upload Attachments.

    Example: Use the /api/v1/attachments endpoint to upload files before referencing them in the record update.

  • Fixed Date Calculation Fields:

    Example: "2024-06-15"

    Fixed date calculation fields expect a date string formatted as YYYY-MM-DD.

  • Calculation Fields:

    Example: "1.0"

    Calculation fields expect a numeric value as a string. These values are often the result of other field calculations and should adhere to the numeric format specified.

Using email

The Contextual Notifications feature offers the ability to set Custom Fields and System Fields in outbound emails. As a result, Record ID is a System Field that can be included in outbound emails from the Risk Cloud. This Record ID could in turn be parsed from the email for use in the following Post Record Comment API request.

Using the Risk Cloud API

Reference the article Risk Cloud API: Record Search to obtain record IDs via the Risk Cloud API.

Get Field ID

The field ID for the fieldId property can be obtained from either your Risk Cloud web app environment directly or from the Risk Cloud API.

Get Field ID (Web App Environment)

The field ID can be located within your Risk Cloud web app environment in the following location:

  • Navigate to Build > Applications
  • Search for and open the application containing the step
  • Open the workflow containing the step
  • Open the step
  • Open the field for editing
  • The field ID can be found in the Field ID section

Get Field ID (Risk Cloud API)

The field ID can be located via the Retrieve Fields endpoint, specifically in the id property of field objects returned in the content property of the response.

GET/api/v2/fields