Update Record activity

  • Release version: Zurich
  • Updated July 31, 2025
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Update Record activity

    The Update Record activity enables you to update a record with specified field values within a playbook. It is accessible as a common activity and can be added by users with admin, playbook.admin, or pdauthor roles. This activity supports both automated and user-interactive scenarios to update records in specified tables.

    Show full answer Show less

    Inputs

    You configure the activity by setting inputs in the activity properties panel:

    • Label and Description: Define the display title and information about the activity’s purpose.
    • Run condition: Use conditions based on prior activity data to control when the activity runs.
    • Start Rule: Choose when the activity or stage begins, either at playbook start, stage start, or after specified activities or stages complete, with an optional delay.
    • Table and Record: Specify the target table and the particular record to update.
    • Fields Template Value: Define the fields and values to update on the record.
    • Wait for user input: Optionally pause the playbook until an end user completes or skips the activity; editable only by playbook.admin role.

    Advanced inputs allow further customization, such as assigning the task to a group or user, and specifying fields to show after the record update.

    Outputs

    The activity outputs include:

    • Table: The table containing the updated record.
    • Record Document ID: Reference to the updated record, which can be used as inputs for subsequent activities in the playbook.

    Design considerations

    • Create form views: Design forms to show only necessary fields for updating records, focusing on required or validated fields to streamline user interaction.
    • Order of activities: Run non-interactive Update Record activities before interactive ones to avoid blocking dependent activities in the playbook, ensuring smoother execution flow.

    Update a record with the field values you specify.

    Roles and availability

    • This activity is available as a common activity. Users with the admin, playbook.admin, or pd_author can add this activity to a playbook.

    Inputs

    Open the activity properties panel and configure your activity to add values for the following inputs. If the input value varies, use the pill-picker to show where to get the value. To learn more about the pill-picker, see .
    Input Type Description
    Label String Title to display as activity and playbook card.
    Description String Information to display about activity usage or outcome.
    Run condition Condition Builder Conditions that must be met to run an activity or stage. You can use data from prior activities to build conditions.
    Note:
    Select Show additional options to see this field.
    Start Rule Choice Under Schedule > Start Rule, select a start rule for when your stage should start running:
    • When process starts: Your stage starts running as soon as the playbook starts.
    • After specific stages: Your stage starts running after specified stage(s) have finished running.
    Under Schedule > Start Rule, select a start rule for when your activity should start running:
    • When stage starts: Your activity starts running as soon as its stage starts running. Your stage starts running when your playbook is triggered.
    • After specific activities: Your activity starts running after specified activities have finished running.
    Start with delay True/False Option to wait for a duration of time before running an activity or stage. When enabled, this input displays the Start with delay input properties.
    Note:
    Select Show additional options to see this field.
    Table Table Name Table containing the record to update.
    Record Reference Reference to the record you want to update.
    Fields Template Value Field values to change during record update.
    Wait for user input Choice Option to pause the playbook until the end user manually completes or skips the activity. Only users with the playbook.admin role can edit this field. By default, the activity waits for user action or data before it completes.

    Advanced inputs

    After configuring the required inputs for your activity, you can also choose to configure additional inputs. In the side panel, select Show additional options to display these advanced inputs. For more information, see Activity experience.
    Input Type Description
    Assignment Group Reference.Group [sys_user_group] Group responsible for completing the task associated with the activity.
    Note:
    Select Show additional options to see this field.
    Assigned To Reference.User [sys_user] User responsible for completing the task associated with the activity.
    Note:
    Select Show additional options to see this field.
    Fields to show after update String Comma-separated list of fields to display for an updated record.

    Outputs

    These outputs can provide data to other activities in your playbook. You can access this data as activity inputs when you configure your activity:
    Output Type Description
    Table Table Name Table containing updated record.
    Record Document ID Reference to record updated.

    Design considerations

    Create form views for activities that you want to render in a playbook
    Use a form view to display only the fields your users need to update a record. Your view should display required fields or those fields validated by other business logic. See View Management.
    Run non-interactive activities before interactive activities
    If an Update Record activity interactively gathers data from users, it prevents the playbook from starting any dependent activities. For example, an Update Record activity would prevent starting After Previous activities, which may be in other stages. Where possible, design your playbooks to run non-interactive activities before interactive activities that could block them.