Number of results per page
- Create carrier contact
MVMNT API (1.0.0)
The MVMNT API enables you to automate freight brokerage workflows by integrating directly with our Transportation Management System.
OAuth 2.0 client credentials flow. See Authentication Guide for details.
Headers:
Content-Type: application/x-www-form-urlencodedBody Parameters:
grant_type=client_credentials
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRETcurl -X POST https://api.mvmnt.io/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=YOUR_CLIENT_ID" \
-d "client_secret=YOUR_CLIENT_SECRET"- Mock serverhttps://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/filter
- Productionhttps://api.mvmnt.io/v1/carrier-contacts/filter
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/filter \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"filter": {
"and": [
{
"contactTypes": {
"includes": "DISPATCH"
}
},
{
"email": {
"isNotNull": true
}
}
]
},
"pageSize": 50
}'Filtered carrier contacts with pagination
Object type identifier
Unique contact identifier
Client-defined reference ID if set
When the carrier was created
When the carrier was last updated
Contact person's name (denormalized from ContactInfo for convenience)
Types/roles this contact serves
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Client-defined reference identifier
When the contact was created
{ "data": [ { … } ], "pageInfo": { "pageSize": 50, "hasNextPage": true, "hasPreviousPage": false, "endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9" } }
Carrier this contact belongs to
Types/roles this contact serves
- Mock serverhttps://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts
- Productionhttps://api.mvmnt.io/v1/carrier-contacts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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"
}'Carrier contact created successfully
Unique contact identifier
Client-defined reference ID if set
When the carrier was created
When the carrier was last updated
Contact person's name (denormalized from ContactInfo for convenience)
Types/roles this contact serves
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Client-defined reference identifier
When the contact was created
{ "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", "deletedAt": null }, "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", "deletedAt": null }, "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", "deletedAt": null }, "key": "ERP-CARRIER-CONTACT-001", "createdAt": "2025-01-15T10:00:00Z", "deletedAt": null }
- Mock serverhttps://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/{id}
- Productionhttps://api.mvmnt.io/v1/carrier-contacts/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/550e8400-e29b-41d4-a716-446655440000 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Carrier contact found
Unique contact identifier
Client-defined reference ID if set
When the carrier was created
When the carrier was last updated
Contact person's name (denormalized from ContactInfo for convenience)
Types/roles this contact serves
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Client-defined reference identifier
When the contact was created
{ "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", "deletedAt": null }, "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", "deletedAt": null }, "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", "deletedAt": null }, "key": "ERP-CARRIER-CONTACT-001", "createdAt": "2025-01-15T10:00:00Z", "deletedAt": null }
Request
Partially update a carrier 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
When updating contactInfo, the underlying Contact record is updated.
Contact person's name (should match contactInfo.name if updating both)
Partial contact information update. All fields are optional.
- Omitted fields: Not modified (current value preserved)
- Provided fields: Updated to the new value
- Null values: Clear the field (set to null) where applicable
Types/roles this contact serves (replaces entire array)
- Mock serverhttps://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/{id}
- Productionhttps://api.mvmnt.io/v1/carrier-contacts/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/550e8400-e29b-41d4-a716-446655440000 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"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"
}'Carrier contact updated successfully
Unique contact identifier
Client-defined reference ID if set
When the carrier was created
When the carrier was last updated
Contact person's name (denormalized from ContactInfo for convenience)
Types/roles this contact serves
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Enhanced reference to a user resource (returned in responses). Includes full user details in addition to id/key.
Note: Does NOT include nested references (teams, etc.) to prevent recursion. Maximum nesting depth: 1 level.
Client-defined reference identifier
When the contact was created
{ "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", "deletedAt": null }, "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", "deletedAt": null }, "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", "deletedAt": null }, "key": "ERP-CARRIER-CONTACT-001", "createdAt": "2025-01-15T10:00:00Z", "deletedAt": null }
- Mock serverhttps://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/{id}
- Productionhttps://api.mvmnt.io/v1/carrier-contacts/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://docs.mvmnt.io/_mock/apis/openapi/carrier-contacts/550e8400-e29b-41d4-a716-446655440000 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'