---
title: "Sync Load"
method: POST
path: "/v2/tms/loads/{external_reference_id}/sync"
tags: ["v2", "tms", "loads"]
---

# Sync Load

`POST /v2/tms/loads/{external_reference_id}/sync`

## Request

- Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mentium.io/v2/tms/loads/{external_reference_id}/sync`
- Auth: HTTP bearer

Trigger a sync for a single load from the TMS

This endpoint starts a Temporal workflow to sync the load data from the TMS.
The workflow runs asynchronously on the Vortex queue.

Path Parameters:
    - external_reference_id: The load's external reference ID in the TMS

Query Parameters:
    - integration_connection_id: TMS integration connection ID (required)
    - integration_name: Integration name like 'SUNNYBROOK', 'TAI' (required)

Returns:
    SyncLoadResponse with workflow ID and status

## Path parameters

- `external_reference_id` string, required

## Query parameters

- `integration_connection_id` string, required
- `integration_name` string, required: Integration name (e.g., 'SUNNYBROOK', 'TAI')

## Headers

- `mentium-workspace-id` string, nullable

## Response `200`

Successful Response

- SyncLoadResponse: Response from syncing a single load.
  - `temporal_workflow_id` string, nullable
  - `success` boolean, required
  - `entity_type` string, required
  - `entity_id` string, required
  - `error` string, nullable
  - `message` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mentium/apis/mentium-api.md) - [All operations](https://skmtc.dev/mentium/apis/mentium-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mentium/apis/mentium-api/revisions/b4ed8e59432e?raw)