Orchestration
...
Record Actions
Update/Create Record
7 min
use the update/create native action to make changes to an existing record from the playbook builder, or create a new record from the playbook builder this is also referred to as upsert a combination of "update" and "create " when updating a record, navigate to the inputs tab to upsert a new record or update an existing record you must select an application to continue click the appropriate radio button depending on your need if you select an existing record, the tracking id field automatically displays, since all existing records have a unique identifying tracking id click dismiss to close the window and return to the inputs tab selecting to upsert a record has the same process on the inputs tab as when you configure a create record native action on this window, click select key field to open the application form select the fields to update when a record is updated or created you can only select one field here at the bottom of the inputs tab are append and remove options both only apply to array/multiselect field options when you select append array or multiselect, you're adding to an existing array of items, and if you pass an empty array, or null value, to one of the selected append fields, nothing in the field changes once again, you can apply playbook properties let's say you want to remove values from array/multiselect fields when you select that check box, the action only removes the value(s) passed if they match to an existing array item what happens if you pass five items, but none of them match existing array items? nothing! your values do not change if you remove all items, then the action removes the field from overall results because it no longer contains data basically, the field won't return empty array or null results in a record action you can append and remove on the same record action careful! when valid values are passed through an update record action, it overwrites existing data for example, if you have an existing array of three items and update to pass an array of one item, it now passes the one array item all fields work, except comments, which only work when you append arrays if you want to aggregate/add data to the record action, use append remove all data easily by sending a null for string, numeric, and list types example update and append field the update append field action allows users to modify or add information to a specific field within a record this is beneficial for maintaining accurate data by adding new information without overwriting the original data purpose ensures data continuity by appending new values while preserving the original data ideal for incremental updates, such as adding log entries or notes to a record endpoint and method this action uses the same endpoint as the record update endpoint the http method is typically patch or post , depending on the api configuration required parameters record id the identifier for the specific record to be updated field name the name of the field to update new value the value to append to the existing field data example usage { "record id" "12345", "field name" "text list", "new value" "hello" } screenshot this screenshot shows the update append field setup in swimlane, where you specify the application name, tracking id, and the values to append to the field field properties screenshot here, the text list field properties are shown, with the key set to text list this key is used in the update and append action to identify the field to update you can use the update and append action to add multiple entries to a field, preserving previous data values in the array format