[beta] Cancel a Data Sharing Agreement
Cancels an accepted Data Sharing Agreement, transitioning it to the terminal canceled state and ending all asset sharing under it. Either the provider or the recipient can cancel. Identify the agreement with the id query parameter.
<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).
To use this endpoint, select Write Asset Sharing under the Asset Sharing category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.
Request
- Base URLhttps://api.samsara.com
- AuthHTTP bearer
Query parameters
The unique identifier of the agreement.
Response
OK response.
Example response
{
"data": {
"acceptedAtTime": "2024-01-15T11:00:00Z",
"acceptedByUserId": "678",
"canceledAtTime": "2024-01-15T11:00:00Z",
"canceledByParty": "recipient",
"canceledByUserId": "678",
"createdAtTime": "2024-01-13T10:00:00Z",
"createdByParty": "provider",
"createdByUserId": "111",
"deletedByUserId": "111",
"id": "33333333-3333-3333-3333-333333333333",
"operator": "provider",
"payer": "recipient",
"providerDataPackages": [
"safety",
"maintenance"
],
"providerOrganizationId": "123",
"recipientDataPackages": [
"telematics",
"location",
"telematics",
"all"
],
"recipientOrganizationId": "456",
"rejectedAtTime": "2024-01-15T11:00:00Z",
"rejectedByUserId": "678",
"status": "pending",
"updatedAtTime": "2024-01-13T10:00:00Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.