BVbvnk
Contacts

Update contact

Changed on

:::warning Beta Contacts v3 is in beta and may change as we continue to improve it. Please review the documentation and endpoints carefully, test everything in the sandbox, and reach out to the Solutions team if you need help. :::

Replaces all fields of an existing contact. Supply the full contact payload including the entity object. Fields not included in the request body will be cleared.

put/platform/v3/contacts/{contactId}

Request

Path parameters

contactIdstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The unique identifier of the contact to update.

Request body

descriptionstring

A human-readable label for the contact.

category'DEFAULT'

Contact category.

Example request

{
  "description": "Primary payment partner",
  "category": "DEFAULT",
  "entity": {
    "type": "INDIVIDUAL",
    "relationshipType": "THIRD_PARTY",
    "firstName": "Jane",
    "lastName": "Doe",
    "dateOfBirth": "1990-06-15",
    "address": {
      "addressLine1": "10 Downing Street",
      "city": "London",
      "region": "Greater London",
      "stateCode": "NY",
      "postalCode": "SW1A 2AA",
      "country": "GB"
    }
  }
}

Response

Contact updated

idstring uuid

Unique identifier of the contact.

descriptionstring

A human-readable label for the contact.

categorystring

Contact category.

createdAtstring date-time

Timestamp when the contact was created.

updatedAtstring date-time

Timestamp when the contact was last updated.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "description": "Primary payment partner",
  "category": "DEFAULT",
  "entity": {
    "type": "INDIVIDUAL",
    "relationshipType": "THIRD_PARTY",
    "firstName": "Jane",
    "lastName": "Doe",
    "dateOfBirth": "1990-06-15",
    "address": {
      "addressLine1": "10 Downing Street",
      "city": "London",
      "region": "Greater London",
      "stateCode": "NY",
      "postalCode": "SW1A 2AA",
      "country": "GB"
    }
  },
  "createdAt": "2026-06-10T10:30:00Z",
  "updatedAt": "2026-06-10T10:30:00Z"
}

Changes