Skip to navigation
OrganizationsShare Agreements

Pause Share Agreement

Pause a Share Agreement.

Authentication

AuthorizationBearer

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

Path parameters

share_agreement_idstringRequiredformat: "uuid"

Response

Successful Response
idstringformat: "uuid"
Unique agreement identifier
fleet_idstringformat: "uuid"
The Catena fleet ID sharing their data with you
partner_idstringformat: "uuid"
Your organization ID receiving access to fleet data
fleet_refstring or null
Your internal fleet identifier for mapping Catena fleets to your system. Returned in webhooks and APIs for easy integration.
statusenum

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

Allowed values:
effective_datedatetime
When data access begins. Check this before attempting to fetch fleet data.
expiration_datedatetime or null
When data access ends. Null means no expiration. Status automatically changes to EXPIRED after this date.
scopesmap from strings to enums

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

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