Virtuous CRM icon

Virtuous CRM

Interact with the Virtuous CRM API

Contact Collection → Create Collection for Contact

AI-generated

Summary

Create a custom collection instance for a specific contact by providing the contact ID, the custom collection ID, and the collection fields either as individual fields or a complete JSON payload.

Inputs

  • Contact ID (required) — The contact identifier for whom the collection instance will be created.
  • Custom Collection ID (required) — The identifier of the custom collection to create for the contact.
  • Input Method — Choose between entering collection fields individually ('Using Fields Below') or as a JSON payload ('Using JSON').
  • Fields (required) — The collection fields as a JSON array of objects with 'name' and 'value' pairs, used if 'Using Fields Below' is selected.
  • JSON Data (required) — The complete JSON payload representing the collection fields, used if 'Using JSON' is selected.

Output shape

a JSON object representing the API response upon creating the collection instance.

The operation makes a POST request to the API path /api/Contact/{contactId}/Collection/{customCollectionId} with the collection fields; errors result in a NodeApiError exception.

Links

Discussion