Skip to main content
PATCH
Update Tms Invitation

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

tms_invitation_id
string<uuid>
required

Body

application/json

API model for updating a TMS account invitation

All fields are optional - only provide fields you want to change.

expires_in_hours
integer | null

How long the invitation link remains valid (1-672 hours).

Required range: 1 <= x <= 672
limit_tms
string[] | null

Restrict which transportation management systems the TMS account can connect to.

exclude_tms
string[] | null

Exclude specific transportation management systems from the ones shown to the TMS account.

Response

Successful Response

API model for reading a TMS account invitation

id
string<uuid>
required

Unique invitation identifier

created_at
string<date-time>
required

When the invitation was created

The magic link used to accept the invitation. Share this URL with the TMS account to begin onboarding.

expires_at
string<date-time>
required

The expiration date and time of the invitation

expires_in_hours
integer
required

The number of hours the invitation is valid for.

status
enum<string>
required

The current status of the invitation (active, accepted, declined, expired, or deleted)

Available options:
active,
accepted,
declined,
expired,
deleted
tms_account_ref
string
required

Your internal identifier for the TMS account. Use this to map Catena TMS accounts back to your system.

partner_id
string<uuid>
required

Your organization ID requesting access to TMS account data

partner_slug
string | null
required

The slug of your organization

accepted_at
string<date-time> | null
required

The date and time the invitation was accepted. Null if not accepted.

accepted_by
string | null
required

Identifier of who accepted the invitation on behalf of the TMS account. Null if not accepted.

decline_reason
string | null
required

The reason provided for declining the invitation. Null if invitation was not declined.

declined_at
string<date-time> | null
required

The date the invitation was declined. Null if invitation was not declined.

limit_tms
string[] | null
required

Restrict which transportation management systems the TMS account can connect to.

exclude_tms
string[] | null
required

Exclude specific transportation management systems from the ones shown to the TMS account.

tms_account_id
string<uuid> | null

The Catena TMS account ID created after accepting the invitation. Null if invitation has not been accepted.