Update Tms Invitation
Update an existing TMS invitation (extend expiration or adjust TMS filters).
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Body
API model for updating a TMS account invitation
All fields are optional - only provide fields you want to change.
How long the invitation link remains valid (1-672 hours).
1 <= x <= 672Restrict which transportation management systems the TMS account can connect to.
Exclude specific transportation management systems from the ones shown to the TMS account.
Response
Successful Response
API model for reading a TMS account invitation
Unique invitation identifier
When the invitation was created
The magic link used to accept the invitation. Share this URL with the TMS account to begin onboarding.
The expiration date and time of the invitation
The number of hours the invitation is valid for.
The current status of the invitation (active, accepted, declined, expired, or deleted)
active, accepted, declined, expired, deleted Your internal identifier for the TMS account. Use this to map Catena TMS accounts back to your system.
Your organization ID requesting access to TMS account data
The slug of your organization
The date and time the invitation was accepted. Null if not accepted.
Identifier of who accepted the invitation on behalf of the TMS account. Null if not accepted.
The reason provided for declining the invitation. Null if invitation was not declined.
The date the invitation was declined. Null if invitation was not declined.
Restrict which transportation management systems the TMS account can connect to.
Exclude specific transportation management systems from the ones shown to the TMS account.
The Catena TMS account ID created after accepting the invitation. Null if invitation has not been accepted.