Skip to main content
Released 20th August 2026

​
TMS Invitation Redirect URLs

This release adds redirect URL support to TMS invitation workflows, enabling you to control where users land after accepting or declining an invitation.
Backward-compatible: All new fields are additive. Existing integrations continue to work without changes.

​
New fields on TMS invitations

Three new fields are now available on TMS invitation objects across all related endpoints: These fields are included in request bodies (create and update) and returned in all responses.

​
Affected endpoints

List invitations — GET /v2/orgs/tms-invitationsResponse items now include callback_url, success_redirect_url, and failure_redirect_url.Create invitation — POST /v2/orgs/tms-invitationsRequest body now accepts callback_url, success_redirect_url, and failure_redirect_url. All three fields are returned in the 200 and 201 responses.Get invitation — GET /v2/orgs/tms-invitations/{tms_invitation_id}Response now includes callback_url, success_redirect_url, and failure_redirect_url.Update invitation — PATCH /v2/orgs/tms-invitations/{tms_invitation_id}Request body now accepts callback_url, success_redirect_url, and failure_redirect_url. All three fields are returned in the 200 response.Accept invitation — POST /v2/orgs/tms-invitations/{tms_invitation_id}/acceptResponse now includes callback_url, success_redirect_url, and failure_redirect_url.Decline invitation — POST /v2/orgs/tms-invitations/{tms_invitation_id}/declineResponse now includes callback_url, success_redirect_url, and failure_redirect_url.

​
Usage example

Set redirect URLs when creating a TMS invitation:
The response will include the same fields:

​
TMS Share Agreement Lifecycle Management

This release expands TMS share agreement management with dedicated lifecycle action endpoints, new status values, and enriched agreement fields for better tracking and control.
Minor release: All changes are backward-compatible additions. No migration required for existing integrations.

​
New endpoints

Three new action endpoints give you direct control over the lifecycle of a TMS share agreement:

​
Parameter changes

A new optional query parameter tms_account_ref has been added to filter share agreements by TMS account reference.
The tms_share_agreement_status filter parameter and the status field in responses now support three additional values:

​
Response changes

The TmsShareAgreementRead schema returned by GET /v2/orgs/tms-share-agreements, GET /v2/orgs/tms-share-agreements/{tms_share_agreement_id}, and PATCH /v2/orgs/tms-share-agreements/{tms_share_agreement_id} now includes three new required fields:Example response:
The update endpoint now accepts effective_date and expiration_date in the request body, allowing you to set or update the agreement’s validity window.

​
TSP status field

This release adds a new status field to the TSP update endpoint, allowing you to manage the active state of a TSP organization directly through the API.
Backward-compatible addition: Existing integrations are unaffected. The status field is optional and can be adopted at your own pace.

​
New features

The PATCH /v2/orgs/tsps/{tsp_id} endpoint now accepts a status field in the request body, enabling you to update the status of a TSP organization.
The status field is part of the TspUpdate schema and can be included alongside any other fields you are already updating.

​
Need help?

Organizations API

View complete endpoint documentation for TMS invitations and other organization resources.

Contact support

Questions about integrating redirect URLs? Our team is here to help.