Create an Individual
curl --request POST \
--url https://api.virtuoussoftware.com/api/ContactIndividual \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer>",
"firstName": "<string>",
"lastName": "<string>",
"contactMethods": [
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
},
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
}
],
"prefix": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"gender": "<string>",
"setAsPrimary": "<boolean>",
"setAsSecondary": "<boolean>",
"birthMonth": "<integer>",
"birthDay": "<integer>",
"birthYear": "<integer>",
"approximateAge": "<integer>",
"isDeceased": "<boolean>",
"deceasedDate": "<dateTime>",
"passion": "<string>",
"avatarUrl": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
],
"customCollections": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
firstName: '<string>',
lastName: '<string>',
contactMethods: [
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
},
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
}
],
prefix: '<string>',
middleName: '<string>',
suffix: '<string>',
gender: '<string>',
setAsPrimary: '<boolean>',
setAsSecondary: '<boolean>',
birthMonth: '<integer>',
birthDay: '<integer>',
birthYear: '<integer>',
approximateAge: '<integer>',
isDeceased: '<boolean>',
deceasedDate: '<dateTime>',
passion: '<string>',
avatarUrl: '<string>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
],
customCollections: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
]
})
};
fetch('https://api.virtuoussoftware.com/api/ContactIndividual', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/ContactIndividual"
payload = {
"contactId": "<integer>",
"firstName": "<string>",
"lastName": "<string>",
"contactMethods": [
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
},
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
}
],
"prefix": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"gender": "<string>",
"setAsPrimary": "<boolean>",
"setAsSecondary": "<boolean>",
"birthMonth": "<integer>",
"birthDay": "<integer>",
"birthYear": "<integer>",
"approximateAge": "<integer>",
"isDeceased": "<boolean>",
"deceasedDate": "<dateTime>",
"passion": "<string>",
"avatarUrl": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
],
"customCollections": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/ContactIndividual");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"contactMethods\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"gender\": \"<string>\",\n \"setAsPrimary\": \"<boolean>\",\n \"setAsSecondary\": \"<boolean>\",\n \"birthMonth\": \"<integer>\",\n \"birthDay\": \"<integer>\",\n \"birthYear\": \"<integer>\",\n \"approximateAge\": \"<integer>\",\n \"isDeceased\": \"<boolean>\",\n \"deceasedDate\": \"<dateTime>\",\n \"passion\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ],\n \"customCollections\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/ContactIndividual",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '<integer>',
'firstName' => '<string>',
'lastName' => '<string>',
'contactMethods' => [
[
'type' => '<string>',
'value' => '<string>',
'isOptedIn' => '<boolean>',
'isPrimary' => '<boolean>'
],
[
'type' => '<string>',
'value' => '<string>',
'isOptedIn' => '<boolean>',
'isPrimary' => '<boolean>'
]
],
'prefix' => '<string>',
'middleName' => '<string>',
'suffix' => '<string>',
'gender' => '<string>',
'setAsPrimary' => '<boolean>',
'setAsSecondary' => '<boolean>',
'birthMonth' => '<integer>',
'birthDay' => '<integer>',
'birthYear' => '<integer>',
'approximateAge' => '<integer>',
'isDeceased' => '<boolean>',
'deceasedDate' => '<dateTime>',
'passion' => '<string>',
'avatarUrl' => '<string>',
'customFields' => [
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
]
],
'customCollections' => [
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
],
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/ContactIndividual")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"contactMethods\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"gender\": \"<string>\",\n \"setAsPrimary\": \"<boolean>\",\n \"setAsSecondary\": \"<boolean>\",\n \"birthMonth\": \"<integer>\",\n \"birthDay\": \"<integer>\",\n \"birthYear\": \"<integer>\",\n \"approximateAge\": \"<integer>\",\n \"isDeceased\": \"<boolean>\",\n \"deceasedDate\": \"<dateTime>\",\n \"passion\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ],\n \"customCollections\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/ContactIndividual")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"<integer>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"contactMethods\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"gender\": \"<string>\",\n \"setAsPrimary\": \"<boolean>\",\n \"setAsSecondary\": \"<boolean>\",\n \"birthMonth\": \"<integer>\",\n \"birthDay\": \"<integer>\",\n \"birthYear\": \"<integer>\",\n \"approximateAge\": \"<integer>\",\n \"isDeceased\": \"<boolean>\",\n \"deceasedDate\": \"<dateTime>\",\n \"passion\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ],\n \"customCollections\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/ContactIndividual';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
firstName: '<string>',
lastName: '<string>',
contactMethods: [
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
},
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
}
],
prefix: '<string>',
middleName: '<string>',
suffix: '<string>',
gender: '<string>',
setAsPrimary: '<boolean>',
setAsSecondary: '<boolean>',
birthMonth: '<integer>',
birthDay: '<integer>',
birthYear: '<integer>',
approximateAge: '<integer>',
isDeceased: '<boolean>',
deceasedDate: '<dateTime>',
passion: '<string>',
avatarUrl: '<string>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
],
customCollections: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 200235,
"contactId": 100234,
"prefix": "Mrs.",
"firstName": "Elena",
"middleName": "Maria",
"lastName": "Castellano",
"suffix": null,
"gender": "Female",
"isPrimary": false,
"canBePrimary": true,
"isSecondary": true,
"canBeSecondary": true,
"birthMonth": 8,
"birthDay": 22,
"birthYear": 1974,
"birthDate": "1974-08-22T00:00:00Z",
"approximateAge": 51,
"isDeceased": false,
"passion": "Community health",
"avatarUrl": "https://api.virtuoussoftware.com/api/ContactIndividual/200235/Avatar",
"contactMethods": [
{
"id": 300104,
"type": "Home Email",
"value": "elena.castellano@example.org",
"isOptedIn": true,
"isPrimary": true,
"canBePrimary": true
},
{
"id": 300105,
"type": "Mobile Phone",
"value": "(555) 012-3402",
"isOptedIn": true,
"isPrimary": true,
"canBePrimary": true
}
],
"createDateTimeUtc": "2025-11-15T18:00:00Z",
"createdByUser": "Partner Integration",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"customFields": [],
"customCollections": []
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Contacts and Individuals
Create an Individual
Adds a new individual to an existing contact — for example a spouse on a household, or a staff member at an organization. Send the contactId of the contact they belong to, and use setAsPrimary or setAsSecondary to place them on the record.
POST
/
api
/
ContactIndividual
Create an Individual
curl --request POST \
--url https://api.virtuoussoftware.com/api/ContactIndividual \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contactId": "<integer>",
"firstName": "<string>",
"lastName": "<string>",
"contactMethods": [
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
},
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
}
],
"prefix": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"gender": "<string>",
"setAsPrimary": "<boolean>",
"setAsSecondary": "<boolean>",
"birthMonth": "<integer>",
"birthDay": "<integer>",
"birthYear": "<integer>",
"approximateAge": "<integer>",
"isDeceased": "<boolean>",
"deceasedDate": "<dateTime>",
"passion": "<string>",
"avatarUrl": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
],
"customCollections": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
firstName: '<string>',
lastName: '<string>',
contactMethods: [
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
},
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
}
],
prefix: '<string>',
middleName: '<string>',
suffix: '<string>',
gender: '<string>',
setAsPrimary: '<boolean>',
setAsSecondary: '<boolean>',
birthMonth: '<integer>',
birthDay: '<integer>',
birthYear: '<integer>',
approximateAge: '<integer>',
isDeceased: '<boolean>',
deceasedDate: '<dateTime>',
passion: '<string>',
avatarUrl: '<string>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
],
customCollections: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
]
})
};
fetch('https://api.virtuoussoftware.com/api/ContactIndividual', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/ContactIndividual"
payload = {
"contactId": "<integer>",
"firstName": "<string>",
"lastName": "<string>",
"contactMethods": [
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
},
{
"type": "<string>",
"value": "<string>",
"isOptedIn": "<boolean>",
"isPrimary": "<boolean>"
}
],
"prefix": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"gender": "<string>",
"setAsPrimary": "<boolean>",
"setAsSecondary": "<boolean>",
"birthMonth": "<integer>",
"birthDay": "<integer>",
"birthYear": "<integer>",
"approximateAge": "<integer>",
"isDeceased": "<boolean>",
"deceasedDate": "<dateTime>",
"passion": "<string>",
"avatarUrl": "<string>",
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
],
"customCollections": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
},
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"value": "<string>"
},
{
"name": "<string>",
"value": "<string>"
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/ContactIndividual");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"contactId\": \"<integer>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"contactMethods\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"gender\": \"<string>\",\n \"setAsPrimary\": \"<boolean>\",\n \"setAsSecondary\": \"<boolean>\",\n \"birthMonth\": \"<integer>\",\n \"birthDay\": \"<integer>\",\n \"birthYear\": \"<integer>\",\n \"approximateAge\": \"<integer>\",\n \"isDeceased\": \"<boolean>\",\n \"deceasedDate\": \"<dateTime>\",\n \"passion\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ],\n \"customCollections\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/ContactIndividual",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contactId' => '<integer>',
'firstName' => '<string>',
'lastName' => '<string>',
'contactMethods' => [
[
'type' => '<string>',
'value' => '<string>',
'isOptedIn' => '<boolean>',
'isPrimary' => '<boolean>'
],
[
'type' => '<string>',
'value' => '<string>',
'isOptedIn' => '<boolean>',
'isPrimary' => '<boolean>'
]
],
'prefix' => '<string>',
'middleName' => '<string>',
'suffix' => '<string>',
'gender' => '<string>',
'setAsPrimary' => '<boolean>',
'setAsSecondary' => '<boolean>',
'birthMonth' => '<integer>',
'birthDay' => '<integer>',
'birthYear' => '<integer>',
'approximateAge' => '<integer>',
'isDeceased' => '<boolean>',
'deceasedDate' => '<dateTime>',
'passion' => '<string>',
'avatarUrl' => '<string>',
'customFields' => [
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>',
'displayName' => '<string>'
]
],
'customCollections' => [
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
],
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'value' => '<string>'
],
[
'name' => '<string>',
'value' => '<string>'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.virtuoussoftware.com/api/ContactIndividual")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contactId\": \"<integer>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"contactMethods\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"gender\": \"<string>\",\n \"setAsPrimary\": \"<boolean>\",\n \"setAsSecondary\": \"<boolean>\",\n \"birthMonth\": \"<integer>\",\n \"birthDay\": \"<integer>\",\n \"birthYear\": \"<integer>\",\n \"approximateAge\": \"<integer>\",\n \"isDeceased\": \"<boolean>\",\n \"deceasedDate\": \"<dateTime>\",\n \"passion\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ],\n \"customCollections\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/ContactIndividual")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contactId\": \"<integer>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"contactMethods\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n },\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"isOptedIn\": \"<boolean>\",\n \"isPrimary\": \"<boolean>\"\n }\n ],\n \"prefix\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"gender\": \"<string>\",\n \"setAsPrimary\": \"<boolean>\",\n \"setAsSecondary\": \"<boolean>\",\n \"birthMonth\": \"<integer>\",\n \"birthDay\": \"<integer>\",\n \"birthYear\": \"<integer>\",\n \"approximateAge\": \"<integer>\",\n \"isDeceased\": \"<boolean>\",\n \"deceasedDate\": \"<dateTime>\",\n \"passion\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"customFields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"displayName\": \"<string>\"\n }\n ],\n \"customCollections\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/ContactIndividual';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contactId: '<integer>',
firstName: '<string>',
lastName: '<string>',
contactMethods: [
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
},
{
type: '<string>',
value: '<string>',
isOptedIn: '<boolean>',
isPrimary: '<boolean>'
}
],
prefix: '<string>',
middleName: '<string>',
suffix: '<string>',
gender: '<string>',
setAsPrimary: '<boolean>',
setAsSecondary: '<boolean>',
birthMonth: '<integer>',
birthDay: '<integer>',
birthYear: '<integer>',
approximateAge: '<integer>',
isDeceased: '<boolean>',
deceasedDate: '<dateTime>',
passion: '<string>',
avatarUrl: '<string>',
customFields: [
{name: '<string>', value: '<string>', displayName: '<string>'},
{name: '<string>', value: '<string>', displayName: '<string>'}
],
customCollections: [
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
},
{
name: '<string>',
fields: [{name: '<string>', value: '<string>'}, {name: '<string>', value: '<string>'}]
}
]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 200235,
"contactId": 100234,
"prefix": "Mrs.",
"firstName": "Elena",
"middleName": "Maria",
"lastName": "Castellano",
"suffix": null,
"gender": "Female",
"isPrimary": false,
"canBePrimary": true,
"isSecondary": true,
"canBeSecondary": true,
"birthMonth": 8,
"birthDay": 22,
"birthYear": 1974,
"birthDate": "1974-08-22T00:00:00Z",
"approximateAge": 51,
"isDeceased": false,
"passion": "Community health",
"avatarUrl": "https://api.virtuoussoftware.com/api/ContactIndividual/200235/Avatar",
"contactMethods": [
{
"id": 300104,
"type": "Home Email",
"value": "elena.castellano@example.org",
"isOptedIn": true,
"isPrimary": true,
"canBePrimary": true
},
{
"id": 300105,
"type": "Mobile Phone",
"value": "(555) 012-3402",
"isOptedIn": true,
"isPrimary": true,
"canBePrimary": true
}
],
"createDateTimeUtc": "2025-11-15T18:00:00Z",
"createdByUser": "Partner Integration",
"modifiedDateTimeUtc": "2025-11-15T18:00:00Z",
"modifiedByUser": "Partner Integration",
"customFields": [],
"customCollections": []
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The identifier of the contact this record belongs to.
The first name of the individual.
The last name of the individual.
The contact methods to create for the individual.
Show child attributes
Show child attributes
The name prefix for the individual, for example Mr. or Dr.
The middle name of the individual.
The name suffix for the individual, for example Jr. or III.
The gender of the individual.
When true, this record becomes the primary one for the contact, replacing any existing primary.
When true, this record becomes the secondary one for the contact, replacing any existing secondary.
The month of the birth date, from 1 to 12.
The day of the month of the birth date.
The year of the birth date.
The estimated age of the individual, used when the birth date is unknown.
When true, the individual is marked as deceased.
The date the individual died.
The stated interests or passions of the individual.
The URL of the profile image for the individual.
Custom field values to set on the record. Field names must match custom fields configured for the organization.
Show child attributes
Show child attributes
Custom collection instances to set on the record. Each entry supplies the collection name and the values for its fields.
Show child attributes
Show child attributes
Response
OK
The unique identifier of the record in Virtuous.
The identifier of the contact this record belongs to.
When true, this is the primary record for the contact.
When true, this record is eligible to be made the primary one.
When true, this is the secondary record for the contact.
When true, this record is eligible to be made the secondary one.
Show child attributes
Show child attributes
The UTC date and time the record was created.
The name of the user who created the record.
The UTC date and time the record was last modified.
The name of the user who last modified the record.
The custom field values stored on the record.
Show child attributes
Show child attributes
The custom collection instances stored on the record.
Show child attributes
Show child attributes
Last modified on August 11, 2026
Was this page helpful?
⌘I