Skip to navigation
OrganizationsTMS Share Agreements

Update Tms Share Agreement

Update an existing TMS Share Agreement.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

tms_share_agreement_idstringRequiredformat: "uuid"
The ID of the TMS Share Agreement to update

Request

This endpoint expects an object.
scopesmap from strings to enums or nullOptional

Defines which TMS-sourced resources (loads, shipments, carriers, etc.) you can access and the permission level (read, write) for each.

Allowed values:

Response

Successful Response
idstringformat: "uuid"
Unique agreement identifier
partner_idstringformat: "uuid"
Your organization ID receiving access to TMS account data
tms_account_idstringformat: "uuid"
The Catena TMS account ID sharing their data with you
tms_invitation_idstring or nullformat: "uuid"
The TMS invitation that was accepted to create this agreement, if any
statusenum

Current state: ACTIVE (data access enabled) or DELETED (permanently removed)

Allowed values:
scopesmap from strings to enums

Defines which TMS-sourced resources (loads, shipments, carriers, etc.) you can access and the permission level (read, write) for each.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error