Virtuous CRM icon

Virtuous CRM

Interact with the Virtuous CRM API

Contact Individual Collection → Create Collection for Individual

AI-generated

Summary

Create a custom collection instance for a specified contact individual in Virtuous CRM, specifying collection details either via individual fields or a complete JSON payload.

Inputs

  • Contact Individual ID (required) — The unique identifier of the contact individual for whom to create the collection.
  • Custom Collection ID (required) — The identifier of the custom collection definition to apply.
  • Input Method — Choose how to provide collection data: either 'Using Fields Below' to specify name and fields separately, or 'Using JSON' to submit a complete JSON payload.
  • Name (required) — The name for the collection instance (used when 'Using Fields Below' input method is selected).
  • Fields (required) — A JSON array specifying the collection fields as name-value pairs (used when 'Using Fields Below' input method is selected).
  • JSON Data — A complete JSON payload including collection name and fields (used when 'Using JSON' input method is selected).

Output shape

a single record

Returns the API response for the creation of the contact individual collection instance. The response structure matches Virtuous CRM's collection instance creation response. Errors throw a NodeApiError.

Examples

Example 1: Create a collection instance by specifying name and fields

Set the Contact Individual ID and Custom Collection ID, choose 'Using Fields Below' input method, provide a name for the collection and a JSON array of fields with their values.

Example 2: Create a collection instance by providing full JSON

Set Contact Individual ID and Custom Collection ID, choose 'Using JSON' input method, and supply the full JSON data with 'name' and 'fields' array as required by the API.

Links

Discussion