update method modifies an existing record in the collection.
Configuration Example
Configuration Options
fields(array): Whitelist of fields that can be updatedexcludedFields(array): Fields that cannot be updated
Implementation Examples
REST API Mapping Implementation (Recommended)
File:update.rest.yml
Operation Mapping Implementation
File:update.yml
JavaScript Implementation
File:update.js
Input
| Property | Type | Description |
|---|---|---|
id | string | The ID of the record to update |
fields | object | Updated fields in API format (after fieldsToApi) |
credentials | object | Authentication credentials |
parameters | object | Method-specific parameters |
Return Value
| Property | Type | Description |
|---|---|---|
id | string | The ID of the updated record |