Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Users

Update user

Partially update a user. Only provided fields will be updated.

patch/users/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

emailstring email

User's email address

namestring nullable

User's full name

phonestring nullable

User's phone number

phoneExtstring nullable

Phone extension

status'PENDING' | 'ACTIVE' | 'INACTIVE'

User account status:

  • PENDING: User invited but has not completed onboarding
  • ACTIVE: User account is active and can access the system
  • INACTIVE: User account is deactivated
rolesUserRole[]

User's roles (replaces all existing roles)

keystring nullable

Client-defined reference identifier

datUsernamestring nullable

DAT integration username

mcpUsernamestring nullable

MyCarrierPortal integration username

avatarIdstring uuid nullable

Profile avatar document ID

Example request

{
  "email": "john.doe@example.com",
  "name": "John Doe",
  "phone": "+1-555-123-4567",
  "phoneExt": "123",
  "roles": [
    "CUSTOMER_REP",
    "ADMIN"
  ],
  "key": "ERP-USER-12345",
  "datUsername": "johndoe_dat",
  "mcpUsername": "johndoe_mcp",
  "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "teams": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    },
    {
      "key": "TEAM-WEST-COAST"
    }
  ]
}

Response

User updated successfully

object'USER'

Object type identifier

idstring uuid required

Unique user identifier

emailstring email required

User's email address

namestring nullable

User's full name

phonestring nullable

User's phone number

phoneExtstring nullable

Phone extension

status'PENDING' | 'ACTIVE' | 'INACTIVE' required

User account status:

  • PENDING: User invited but has not completed onboarding
  • ACTIVE: User account is active and can access the system
  • INACTIVE: User account is deactivated
rolesUserRole[] required

User's roles within the organization

keystring nullable

Client-defined reference identifier for this user

datUsernamestring nullable

DAT (Load Board) integration username

mcpUsernamestring nullable

MyCarrierPortal integration username

avatarIdstring uuid nullable

Profile avatar document ID

createdAtstring date-time required

Timestamp when user was created

updatedAtstring date-time required

Timestamp when user was last updated

deletedAtstring date-time nullable

Timestamp when user was soft-deleted (null if active)

Example response

{
  "object": "USER",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "name": "John Doe",
  "phone": "+1-555-123-4567",
  "phoneExt": "123",
  "roles": [
    "CUSTOMER_REP",
    "ADMIN"
  ],
  "key": "ERP-USER-12345",
  "datUsername": "johndoe_dat",
  "mcpUsername": "johndoe_mcp",
  "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "teams": [
    {
      "object": "TEAM",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Sales Team - West Coast",
      "key": "ERP-TEAM-WEST",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z"
}