Update an Individual

PUT

/api/ContactIndividual/:contactIndividualId

PUT

/api/ContactIndividual/:contactIndividualId

curl -X PUT https://api.virtuoussoftware.com/api/ContactIndividual/contactIndividualId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "firstName": "<string>",
  "lastName": "<string>",
  "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>"
        }
      ]
    }
  ]
}'

{
  "id": "<integer>",
  "contactId": "<integer>",
  "prefix": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "suffix": "<string>",
  "gender": "<string>",
  "isPrimary": "<boolean>",
  "canBePrimary": "<boolean>",
  "isSecondary": "<boolean>",
  "canBeSecondary": "<boolean>",
  "birthMonth": "<integer>",
  "birthDay": "<integer>",
  "birthYear": "<integer>",
  "birthDate": "<string>",
  "approximateAge": "<integer>",
  "isDeceased": "<boolean>",
  "deceasedDate": "<dateTime>",
  "passion": "<string>",
  "avatarUrl": "<string>",
  "contactMethods": [
    {
      "id": "<integer>",
      "type": "<string>",
      "value": "<string>",
      "isOptedIn": "<boolean>",
      "isPrimary": "<boolean>",
      "canBePrimary": "<boolean>"
    },
    {
      "id": "<integer>",
      "type": "<string>",
      "value": "<string>",
      "isOptedIn": "<boolean>",
      "isPrimary": "<boolean>",
      "canBePrimary": "<boolean>"
    }
  ],
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ],
  "customCollections": [
    {
      "customCollectionId": "<integer>",
      "customCollectionName": "<string>",
      "collectionInstanceId": "<integer>",
      "fields": [
        {
          "name": "<string>",
          "value": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    },
    {
      "customCollectionId": "<integer>",
      "customCollectionName": "<string>",
      "collectionInstanceId": "<integer>",
      "fields": [
        {
          "name": "<string>",
          "value": "<string>"
        },
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}

Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only updating a single property, the entire model is still required.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

contactIndividualIdstringRequired

Request

This endpoint expects an object.

firstNamestringOptional

lastNamestringOptional

prefixstringOptional

middleNamestringOptional

suffixstringOptional

genderstringOptional

setAsPrimarystringOptional

setAsSecondarystringOptional

birthMonthstringOptional

birthDaystringOptional

birthYearstringOptional

approximateAgestringOptional

isDeceasedstringOptional

deceasedDatestringOptional

passionstringOptional

avatarUrlstringOptional

customFieldslist of objectsOptional

customCollectionslist of objectsOptional

Response

idstringOptional

contactIdstringOptional

prefixstringOptional

firstNamestringOptional

middleNamestringOptional

lastNamestringOptional

suffixstringOptional

genderstringOptional

isPrimarystringOptional

canBePrimarystringOptional

isSecondarystringOptional

canBeSecondarystringOptional

birthMonthstringOptional

birthDaystringOptional

birthYearstringOptional

birthDatestringOptional

approximateAgestringOptional

isDeceasedstringOptional

deceasedDatestringOptional

passionstringOptional

avatarUrlstringOptional

contactMethodslist of objectsOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

customFieldslist of objectsOptional

customCollectionslist of objectsOptional

Errors

400

Bad Request Error