> ## Documentation Index
> Fetch the complete documentation index at: https://docs.catenatelematics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# v2.43.0

> 3 changes across providers, TMS and analytics

**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.

<Check>
  **Backward-compatible:** All new fields are additive. Existing integrations continue to work without changes.
</Check>

### New fields on TMS invitations

Three new fields are now available on TMS invitation objects across all related endpoints:

| Field | Type | Description |
| - | - | - |
| `callback_url` | string | URL called when the invitation flow completes |
| `success_redirect_url` | string | URL to redirect the user to after a successful acceptance |
| `failure_redirect_url` | string | URL to redirect the user to if the invitation flow fails |

These fields are included in request bodies (create and update) and returned in all responses.

### Affected endpoints

<AccordionGroup>
  <Accordion title="TMS Invitations" icon="envelope">
    **List invitations** — `GET /v2/orgs/tms-invitations`

    Response items now include `callback_url`, `success_redirect_url`, and `failure_redirect_url`.

    **Create invitation** — `POST /v2/orgs/tms-invitations`

    Request 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}/accept`

    Response now includes `callback_url`, `success_redirect_url`, and `failure_redirect_url`.

    **Decline invitation** — `POST /v2/orgs/tms-invitations/{tms_invitation_id}/decline`

    Response now includes `callback_url`, `success_redirect_url`, and `failure_redirect_url`.
  </Accordion>
</AccordionGroup>

### Usage example

Set redirect URLs when creating a TMS invitation:

```bash theme={null}
POST /v2/orgs/tms-invitations
Content-Type: application/json

{
  "callback_url": "https://your-app.com/webhooks/invitation",
  "success_redirect_url": "https://your-app.com/onboarding/complete",
  "failure_redirect_url": "https://your-app.com/onboarding/error"
}
```

The response will include the same fields:

```json theme={null}
{
  "id": "inv_abc123",
  "callback_url": "https://your-app.com/webhooks/invitation",
  "success_redirect_url": "https://your-app.com/onboarding/complete",
  "failure_redirect_url": "https://your-app.com/onboarding/error"
}
```

## 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.

<Check>
  **Minor release:** All changes are backward-compatible additions. No migration required for existing integrations.
</Check>

### New endpoints

<AccordionGroup>
  <Accordion title="TMS share agreement lifecycle actions" icon="play">
    Three new action endpoints give you direct control over the lifecycle of a TMS share agreement:

    | Endpoint | Description |
    | - | - |
    | `POST /v2/orgs/tms-share-agreements/{tms_share_agreement_id}/activate` | Activate a share agreement |
    | `POST /v2/orgs/tms-share-agreements/{tms_share_agreement_id}/pause` | Pause an active share agreement |
    | `POST /v2/orgs/tms-share-agreements/{tms_share_agreement_id}/cancel` | Cancel a share agreement |

    ```bash theme={null}
    # Activate a share agreement
    POST /v2/orgs/tms-share-agreements/{tms_share_agreement_id}/activate

    # Pause a share agreement
    POST /v2/orgs/tms-share-agreements/{tms_share_agreement_id}/pause

    # Cancel a share agreement
    POST /v2/orgs/tms-share-agreements/{tms_share_agreement_id}/cancel
    ```
  </Accordion>
</AccordionGroup>

### Parameter changes

<AccordionGroup>
  <Accordion title="GET /v2/orgs/tms-share-agreements — new filter parameter" icon="filter">
    A new optional query parameter `tms_account_ref` has been added to filter share agreements by TMS account reference.

    ```bash theme={null}
    # Filter by TMS account reference
    GET /v2/orgs/tms-share-agreements?tms_account_ref=my-account-ref
    ```
  </Accordion>

  <Accordion title="tms_share_agreement_status — new enum values" icon="list">
    The `tms_share_agreement_status` filter parameter and the `status` field in responses now support three additional values:

    | New value | Description |
    | - | - |
    | `paused` | Agreement is temporarily paused |
    | `cancelled` | Agreement has been cancelled |
    | `expired` | Agreement has passed its expiration date |

    ```bash theme={null}
    # Filter by new status values
    GET /v2/orgs/tms-share-agreements?tms_share_agreement_status=paused
    GET /v2/orgs/tms-share-agreements?tms_share_agreement_status=cancelled
    GET /v2/orgs/tms-share-agreements?tms_share_agreement_status=expired
    ```
  </Accordion>
</AccordionGroup>

### Response changes

<AccordionGroup>
  <Accordion title="TmsShareAgreementRead — new fields" icon="sparkles">
    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:

    | Field | Type | Description |
    | - | - | - |
    | `tms_account_ref` | string | Reference to the associated TMS account |
    | `effective_date` | string | The date the agreement becomes effective |
    | `expiration_date` | string | The date the agreement expires |

    Example response:

    ```json theme={null}
    {
      "id": "...",
      "status": "active",
      "tms_account_ref": "my-tms-account",
      "effective_date": "2026-01-01",
      "expiration_date": "2027-01-01"
    }
    ```
  </Accordion>

  <Accordion title="PATCH /v2/orgs/tms-share-agreements/{tms_share_agreement_id} — new request body fields" icon="wrench">
    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.

    ```json theme={null}
    {
      "effective_date": "2026-01-01",
      "expiration_date": "2027-01-01"
    }
    ```
  </Accordion>
</AccordionGroup>

## 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.

<Check>
  **Backward-compatible addition:** Existing integrations are unaffected. The `status` field is optional and can be adopted at your own pace.
</Check>

### New features

<AccordionGroup>
  <Accordion title="TSP status management" icon="building">
    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.

    ```bash theme={null}
    PATCH /v2/orgs/tsps/{tsp_id}
    Content-Type: application/json

    {
      "status": "active"
    }
    ```

    The `status` field is part of the `TspUpdate` schema and can be included alongside any other fields you are already updating.
  </Accordion>
</AccordionGroup>

***

## Need help?

<CardGroup cols={2}>
  <Card title="Organizations API" icon="building" href="/api-reference/organizations-api">
    View complete endpoint documentation for TMS invitations and other organization resources.
  </Card>

  <Card title="Contact support" icon="life-ring" href="mailto:support@catenaclearing.io">
    Questions about integrating redirect URLs? Our team is here to help.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.