Sign in
latestOpenAPI 3.1.0Proprietary2026-08-21180410901.1 KB

7af4e91459ca

Vendor Contacts

Create a new vendor contact

Create a new contact for a vendor.

Contacts represent individuals at the vendor who can be reached for various purposes.

post/vendor-contacts

Request body

vendorIdstring uuid required

Vendor this contact belongs to

namestring required

Contact person's name (required)

emailstring email

Contact email address

phonestring

Contact phone number

rolestring

Contact role or title (deprecated - use roles array)

rolesVendorContactRole[]

Types/roles this contact serves

Example request

{
  "vendorId": "550e8400-e29b-41d4-a716-446655440001",
  "name": "John Smith",
  "email": "john.smith@abcwarehouse.com",
  "phone": "+1-555-123-4567",
  "role": "Billing Manager",
  "roles": [
    "BILLING",
    "AGENT"
  ]
}

Response

Vendor contact created 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"
}