VRPlatformVRPlatform
Contacts

/contacts/{id}

Update a contact by ID. Vendor-only write permission requires both the stored and requested contact types to remain vendor; an empty body leaves the contact unchanged.

Required scope: one of: contacts:write, contacts:vendors:write

PUT
/contacts/{id}

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

dryRun?boolean

Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode.

Request Body

application/json

address?|null
type?string
Value in"owner" | "vendor"
email?string|null
firstName?string|null
name?string|null
phone?string|null
connectionId?string|null
companyType?string|null
taxIdentifier?string|null
sourceId?string|null
uniqueRef?string|null
status?string|null
payoutAccountId?string|null
defaultPaymentMethod?string|null
statementEmailEnabled?boolean

Turn owner statement emails on or off for this owner. true also resumes an owner who unsubscribed.

statementEmailUnsubscribedAt?null

Send null to resume owner statement emails after the owner unsubscribed.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://api.vrplatform.app/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "address": {
    "full": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "stateCode": "string",
    "countryCode": "string"
  },
  "type": "owner",
  "email": "user@example.com",
  "firstName": "string",
  "name": "string",
  "phone": "string",
  "connectionId": "string",
  "companyType": "c_corporation",
  "taxIdentifier": "string",
  "uniqueRef": "string",
  "status": "active",
  "payoutAccountId": "f16cca2a-0289-41e7-992d-7fd2e711757a",
  "defaultPaymentMethod": "rampAch",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "shortRef": "string",
  "source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "status": "active",
    "appId": "string",
    "appIcon": "string"
  },
  "pmsStatus": "active",
  "ownershipPeriods": [
    {
      "listingId": "string",
      "listingName": "string",
      "split": 0,
      "startAt": "string",
      "endAt": "string"
    }
  ],
  "activeOwnerships": [
    {
      "listingId": "string",
      "listingName": "string",
      "split": 0,
      "startAt": "string",
      "endAt": "string"
    }
  ],
  "access": {
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "email": "user@example.com",
    "secondaryEmails": [
      "user@example.com"
    ],
    "status": "active",
    "lastSeen": "2024-01-15T12:30:00.000+00:00",
    "lastInvitedAt": "2024-01-15T12:30:00.000+00:00",
    "notifications": {
      "ownerStatementPublished": true
    }
  },
  "statementEmailEnabled": true,
  "statementEmailUnsubscribedAt": "2024-01-15T12:30:00.000+00:00",
  "addressEditedAt": "2024-01-15T12:30:00.000+00:00",
  "bankAccount": {
    "holderName": "string",
    "holderType": "individual",
    "accountKind": "checking",
    "routingNumber": "string",
    "last4": "stri",
    "updatedAt": "2024-01-15T12:30:00.000+00:00",
    "updatedBy": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "email": "string"
    },
    "updatedByApiKeyId": "b949890d-0339-4ca1-9c29-8a993e122546"
  },
  "bankDetailsStatus": "notSetUp",
  "bankDetailsRequest": {
    "requestedAt": "2024-01-15T12:30:00.000+00:00",
    "delivery": "queued",
    "recipientEmail": "string",
    "sentAt": "2024-01-15T12:30:00.000+00:00",
    "expiresAt": "2024-01-15T12:30:00.000+00:00",
    "openedAt": "2024-01-15T12:30:00.000+00:00"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "LOCKED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/owner-portal-previews/exchange POST

Previous Page

/contacts/{contactId}/payouts GET

Next Page