Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Vendor Contacts

Update a vendor contact

Partially update a vendor contact. Only provided fields will be updated.

  • Omitted fields: Not modified (current value preserved)
  • Provided fields: Updated to the new value
  • Null values: Clear the field (set to null) where applicable
patch/vendor-contacts/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Request body

emailstring email nullable

Contact email address

phonestring nullable

Contact phone number

rolestring nullable

Contact role or title (deprecated - use roles array)

rolesVendorContactRole[] nullable

Types/roles this contact serves (replaces entire array)

Example request

{
  "email": "john.smith@abcwarehouse.com",
  "phone": "+1-555-123-4567",
  "role": "Billing Manager",
  "roles": [
    "BILLING",
    "AGENT"
  ]
}

Response

Vendor contact updated successfully

object'VENDOR_CONTACT'

Object type identifier

emailstring email nullable

Contact email address

phonestring nullable

Contact phone number

rolestring nullable

Contact role or title (deprecated - use roles array)

rolesVendorContactRole[] nullable

Types/roles this contact serves

createdAtstring date-time required

When the contact was created

deletedAtstring date-time nullable

When the contact was soft deleted (null if active)

Example response

{
  "object": "VENDOR_CONTACT",
  "vendor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345"
  },
  "email": "john.smith@abcwarehouse.com",
  "phone": "+1-555-123-4567",
  "role": "Billing Manager",
  "roles": [
    "BILLING",
    "AGENT"
  ],
  "deletedBy": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-USER-12345",
    "email": "john.doe@example.com",
    "name": "John Doe",
    "phone": "+1-555-123-4567",
    "phoneExt": "123",
    "status": "ACTIVE",
    "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "createdAt": "2025-01-15T10:00:00Z"
}