Pause Tms Share Agreement
Pause a TMS Share Agreement.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
Successful Response
API model for reading a sharing agreement
Contains all the details about what TMS-sourced data you can access from a TMS account.
Unique agreement identifier
Your organization ID receiving access to TMS account data
The Catena TMS account ID sharing their data with you
The TMS invitation that was accepted to create this agreement, if any
Your internal identifier for this TMS account, for mapping Catena TMS accounts to your system. Returned in webhooks and APIs for easy integration.
Current state: ACTIVE (data access enabled), PAUSED (temporarily disabled), CANCELLED (permanently ended), EXPIRED (past expiration_date), or DELETED (permanently removed)
active, paused, cancelled, deleted, expired When data access begins. Check this before attempting to fetch TMS account data.
When data access ends. Null means no expiration. Status automatically changes to EXPIRED after this date.
Defines which TMS-sourced resources (loads, shipments, carriers, etc.) you can access and the permission level (read, write) for each.