Bill Payments8

Bills11

Carrier Contacts5

Carrier Factors6

Carrier Payment Methods5

Carriers8

Companies5

Credit Memos8

Customer Contacts5

Customers8

Documents20

Invoices11

Loads13

Location Contacts5

Locations6

Payment Terms5

Payments6

Quotes6

Reference Data3

Saved Searches5

Search1

Services5

Shipments16

Stops5

Teams5

Users6

Vendor Contacts5

Vendor Payment Methods5

Vendors8

Webhooks

Event Notifications1

Users

Update user

Changed on Oct 7, 2026

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

patch/users/{id}

Request

Base URL: https://api.mvmnt.io/v1
URL: https://api.mvmnt.io/v1/users/{id}
Auth: HTTP bearer

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"
}

Changes

Oct 7, 20262cd6ecfbeb82 Revision changes
- breaking
  the response's body type changed from object to no type for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  the optional response header X-RateLimit-Reset removed for the status 429
- info
  added subschema #2 to the response body allOf list for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Aug 15, 2026ce0e9003047c Revision changes
- warning
  added the new MANAGER enum value to the / response property for the response status
- info
  added the new MANAGER enum value to the request property /

Operation history