Update Tsp

PATCH

https://api.catenatelematics.com/v2/orgs/tsps/:tsp_id

PATCH

/v2/orgs/tsps/:tsp_id

curl -X PATCH https://api.catenatelematics.com/v2/orgs/tsps/tsp_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "name": "Samsara",
  "source_name": "samsara",
  "conn_type": "oauth2",
  "id": "11223344-5566-7788-99aa-bbccddeeff00",
  "slug": "samsara",
  "created_at": "2024-01-15T09:00:00Z",
  "updated_at": "2025-11-20T16:45:00Z",
  "description": "Connected operations platform for fleet management and industrial operations",
  "websites": [
    "https://www.samsara.com"
  ],
  "status": "active",
  "is_sandbox": false,
  "logo_url": "https://cdn.sanity.io/images/abc123/samsara-logo.png",
  "logo_dark_url": "https://cdn.sanity.io/images/abc123/samsara-logo-dark.png",
  "registry": "fmcsa",
  "compliance_status": "compliant"
}

Update an existing TSP.

Authentication

AuthorizationBearer

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

Path parameters

tsp_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

namestring or nullOptional

TSP display name

source_nameenum or nullOptional

Unique TSP identifier enum value

conn_typeenum or nullOptional

Authentication method (OAuth, API Key, etc.)

descriptionstring or nullOptional

Description of the TSP and its services

Response

Successful Response

namestring

source_nameenum

TSP enum identifier for API references

conn_typeenum

The type of connection usedt to authenticate with the TSP

idstringformat: "uuid"

Unique Catena TSP identifier

slugstring

URL-friendly TSP identifier

created_atdatetime

When the TSP was added to Catena

updated_atdatetime

Last modification timestamp

descriptionstring or nullOptional

A description of the TSP

websiteslist of strings or nullOptional

List of websites associated with the TSP. The website is used to map users to an organization based on their email domain and to authenticate them accordingly in the scope of the organization.

statusenumOptional

The status of the TSP

is_sandboxbooleanOptionalDefaults to false

Indicates whether the TSP is a sandbox integrations for testing purposes.

logo_urlstring or nullOptionalformat: "uri"1-2083 characters

URL to the TSP's logo image, used for display purposes in the UI

logo_dark_urlstring or nullOptionalformat: "uri"1-2083 characters

URL to the TSP's logo image optimized for dark mode, used for display purposes in the UI

ext_tsp_idstring or nullOptionalformat: "uuid"

Linked external TSP ID from regulatory registry

registrystring or nullOptional

The regulatory body that certified this provider (e.g. ‘fmcsa’). None if not linked to any registry.

compliance_statusenumOptional

ELD compliance status. ‘compliant’ means at least one device is registered. ‘non_compliant’ means ALL devices have been revoked. ‘unknown’ means the TSP is not linked to a regulatory registry or has no registered devices.

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