Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Carrier Contacts

Create carrier contact

Create a new carrier contact. The contactInfo will create a new Contact record, and the CarrierContact will reference it via contactId (managed internally).

post/carrier-contacts

Request body

carrierIdstring uuid required

Carrier this contact belongs to

namestring required

Contact person's name (should match contactInfo.name)

contactTypesCarrierContactType[]

Types/roles this contact serves

keystring

Client-defined reference identifier

Example request

{
  "carrierId": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Jane Dispatcher",
  "contactInfo": {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "phoneNumber": "+1-555-0100",
    "title": "Operations Manager"
  },
  "contactTypes": [
    "DISPATCH",
    "AFTER_HOURS"
  ],
  "key": "ERP-CARRIER-CONTACT-001"
}

Response

Carrier contact created successfully

object'CARRIER_CONTACT'

Object type identifier

idstring uuid required

Unique contact identifier

namestring required

Contact person's name (denormalized from ContactInfo for convenience)

contactTypesCarrierContactType[] nullable

Types/roles this contact serves

keystring nullable

Client-defined reference identifier

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": "CARRIER_CONTACT",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "carrier": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CARRIER-SWIFT",
    "name": "Swift Transportation",
    "phoneNumber": "+1-555-987-6543",
    "email": "dispatch@swifttrans.com",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "name": "Jane Dispatcher",
  "contactInfo": {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "phoneNumber": "+1-555-0100",
    "title": "Operations Manager"
  },
  "contactTypes": [
    "DISPATCH",
    "AFTER_HOURS"
  ],
  "invitedUser": {
    "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"
  },
  "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"
  },
  "key": "ERP-CARRIER-CONTACT-001",
  "createdAt": "2025-01-15T10:00:00Z"
}