Skip to main content
PATCH
/
v2
/
orgs
/
share-agreements
/
{share_agreement_id}
Update Share Agreement
curl --request PATCH \
  --url https://api.catenatelematics.com/v2/orgs/share-agreements/{share_agreement_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "effective_date": "2025-12-11T14:22:00Z",
  "fleet_id": "98765432-10fe-dcba-9876-543210fedcba",
  "fleet_ref": "FLEET-12345",
  "id": "22334455-6677-8899-aabb-ccddeeff0011",
  "invitation_id": "01234567-89ab-cdef-0123-456789abcdef",
  "partner_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "scopes": {
    "hos_events": "read",
    "user": "read",
    "vehicle": "read_write",
    "vehicle_location": "read_write"
  },
  "status": "active"
}

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.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
share_agreement_id
string<uuid>
required

The ID of the Share Agreement to update

Body

application/json

Details to be updated int Share Agreement

​
effective_date
string<date-time> | null

When data access begins. Check this before attempting to fetch fleet data.

​
expiration_date
string<date-time> | null

When data access ends. Null means no expiration. Status automatically changes to EXPIRED after this date.

Response

Successful Response

API model for reading a sharing agreement

Contains all the details about what data you can access from a fleet. Monitor the status field to track active agreements.

​
id
string<uuid>
required

Unique agreement identifier

​
fleet_id
string<uuid>
required

The Catena fleet ID sharing their data with you

​
partner_id
string<uuid>
required

Your organization ID receiving access to fleet data

​
fleet_ref
string | null
required

Your internal fleet identifier for mapping Catena fleets to your system. Returned in webhooks and APIs for easy integration.

​
status
enum<string>
required

Current state: ACTIVE (data access enabled), PAUSED (temporarily disabled), CANCELLED (permanently ended), EXPIRED (past expiration_date)

Available options:
active,
paused,
cancelled,
deleted,
expired
​
effective_date
string<date-time>
required

When data access begins. Check this before attempting to fetch fleet data.

​
expiration_date
string<date-time> | null
required

When data access ends. Null means no expiration. Status automatically changes to EXPIRED after this date.

​
scopes
Shared Scopes · object
required

Defines which resources (vehicle, locations, users, etc.) you can access and the permission level (read, write) for each.