MEmentium
v2
tms
v2
tms
carriers

Create Carrier Contact

Create a new contact for a carrier via Vortex gRPC service.

This endpoint creates a contact in the TMS through Vortex gRPC. Vortex handles:

  1. Creating the contact in the TMS
  2. Triggering a carrier sync workflow to update Vortex DB

Path Parameters: - carrier_external_reference_id: The carrier's external reference ID in TMS

Query Parameters: - integration_connection_id: TMS integration connection ID (required)

Request Body: - first_name: Contact's first name (required) - last_name: Contact's last name (required) - primary_email: Contact's email address - primary_phone: Contact's phone number - contact_type: Contact type - one of: DISPATCHER, DRIVER, OPERATIONS, ACCOUNTING, AP, AR, OWNER, OTHER (required) - is_primary_contact: Whether this is the primary contact for the carrier

Returns: Created carrier contact with TMS-generated ID

post/v2/tms/carriers/{carrier_external_reference_id}/contacts

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

carrier_external_reference_idstring required

Query parameters

integration_connection_idstring required

Headers

mentium-workspace-idstring nullable

Request body

first_namestring required

Contact's first name

last_namestring required

Contact's last name

primary_emailstring nullable
primary_phonestring nullable
contact_type'OWNER' | 'OPERATIONS' | 'DISPATCHER' | 'DRIVER' | 'ACCOUNTING' | 'AP' | 'AR' | 'OTHER' | 'MENTIUM_UNKNOWN_VALUE' required
is_primary_contactboolean nullable

Whether this is the primary contact

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 2 revisions of this API.