Update a Contact

PUT

/api/Contact/:contactId

PUT

/api/Contact/:contactId

curl -X PUT https://api.virtuoussoftware.com/api/Contact/contactId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "contactType": "<string>",
  "name": "<string>",
  "informalName": "<string>",
  "description": "<string>",
  "website": "<string>",
  "maritalStatus": "<string>",
  "anniversaryMonth": "<integer>",
  "anniversaryDay": "<integer>",
  "anniversaryYear": "<integer>",
  "originSegmentId": "<integer>",
  "isPrivate": "<boolean>",
  "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>"
        }
      ]
    }
  ]
}'

{
  "isCurrentUserFollowing": "<boolean>",
  "id": "<integer>",
  "contactType": "<string>",
  "isPrivate": "<boolean>",
  "name": "<string>",
  "informalName": "<string>",
  "description": "<string>",
  "website": "<string>",
  "maritalStatus": "<string>",
  "anniversaryMonth": "<integer>",
  "anniversaryDay": "<integer>",
  "anniversaryYear": "<integer>",
  "mergedIntoContactId": "<integer>",
  "address": {
    "id": "<integer>",
    "label": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal": "<string>",
    "country": "<string>",
    "isPrimary": "<boolean>",
    "canBePrimary": "<boolean>",
    "startMonth": "<integer>",
    "startDay": "<integer>",
    "endMonth": "<integer>",
    "endDay": "<integer>"
  },
  "giftAskAmount": "<string>",
  "giftAskType": "<string>",
  "lifeToDateGiving": "<string>",
  "yearToDateGiving": "<string>",
  "lastGiftAmount": "<string>",
  "lastGiftDate": "<string>",
  "contactIndividuals": [
    {
      "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>",
      "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>",
      "modifiedDateTimeUtc": "<dateTime>",
      "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>"
            }
          ]
        }
      ]
    },
    {
      "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>",
      "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>",
      "modifiedDateTimeUtc": "<dateTime>",
      "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>"
            }
          ]
        }
      ]
    }
  ],
  "contactGiftsUrl": "<string>",
  "contactPassthroughGiftsUrl": "<string>",
  "contactPlannedGiftsUrl": "<string>",
  "contactRecurringGiftsUrl": "<string>",
  "contactImportantNotesUrl": "<string>",
  "contactNotesUrl": "<string>",
  "contactTagsUrl": "<string>",
  "contactRelationshipsUrl": "<string>",
  "primaryAvatarUrl": "<string>",
  "contactReferences": [
    {
      "source": "<string>",
      "id": "<string>"
    },
    {
      "source": "<string>",
      "id": "<string>"
    }
  ],
  "originSegmentId": "<integer>",
  "originSegment": "<string>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "tags": [
    "<string>",
    "<string>"
  ],
  "organizationGroups": [
    "<string>",
    "<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

contactIdstringRequired

Request

This endpoint expects an object.

contactTypestringOptional

namestringOptional

informalNamestringOptional

descriptionstringOptional

websitestringOptional

maritalStatusstringOptional

anniversaryMonthstringOptional

anniversaryDaystringOptional

anniversaryYearstringOptional

originSegmentIdstringOptional

isPrivatestringOptional

customFieldslist of objectsOptional

customCollectionslist of objectsOptional

Response

isCurrentUserFollowingstringOptional

idstringOptional

contactTypestringOptional

isPrivatestringOptional

namestringOptional

informalNamestringOptional

descriptionstringOptional

websitestringOptional

maritalStatusstringOptional

anniversaryMonthstringOptional

anniversaryDaystringOptional

anniversaryYearstringOptional

mergedIntoContactIdstringOptional

addressobjectOptional

giftAskAmountstringOptional

giftAskTypestringOptional

lifeToDateGivingstringOptional

yearToDateGivingstringOptional

lastGiftAmountstringOptional

lastGiftDatestringOptional

contactIndividualslist of objectsOptional

contactGiftsUrlstringOptional

contactPassthroughGiftsUrlstringOptional

contactPlannedGiftsUrlstringOptional

contactRecurringGiftsUrlstringOptional

contactImportantNotesUrlstringOptional

contactNotesUrlstringOptional

contactTagsUrlstringOptional

contactRelationshipsUrlstringOptional

primaryAvatarUrlstringOptional

contactReferenceslist of objectsOptional

originSegmentIdstringOptional

originSegmentstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

tagslist of stringsOptional

organizationGroupslist of stringsOptional

customFieldslist of objectsOptional

customCollectionslist of objectsOptional

Errors

400

Bad Request Error