Virtuous CRM icon

Virtuous CRM

Interact with the Virtuous CRM API

Actions13

Contact Collection → Update Collection for Contact

AI-generated

Summary

Update an existing collection instance for a contact by specifying the contact ID and collection instance ID, providing the collection fields either as individual JSON array entries or as a complete JSON payload.

Inputs

  • Contact ID (required) — The identifier of the contact whose collection instance will be updated.
  • Collection Instance ID (required) — The identifier of the collection instance to update.
  • Input Method (required) — Choose how to provide the collection fields: either as individual fields below or a complete JSON payload.
  • Fields (required) — If using 'Using Fields Below' as input method, provide an array of field name-value pairs as JSON to update in the collection instance.
  • JSON Data (required) — If using 'Using JSON' as input method, provide the complete JSON payload representing the collection fields.

Output shape

a JSON object representing the updated collection instance

Input fields must be valid JSON arrays or objects accordingly. The operation issues a PUT request and returns the updated resource data. Throws an error on invalid input or API failure.

Examples

Example 1: Update collection fields individually using fields array

Provide contactId, collectionInstanceId, set inputMethod to 'fields', and specify fields as an array of name-value pairs.

Example 2: Update collection fields using full JSON payload

Provide contactId, collectionInstanceId, set inputMethod to 'json', and specify jsonData as the full JSON object with fields to update.

Links

Discussion