REST API
SUPPORTFEEDBACK

[beta] Create a Data Sharing Agreement

post
https://api.samsara.com/fleet/asset-sharing/agreements

Creates a new Data Sharing Agreement (DSA) in pending status. Only the provider organization can create an agreement, and the recipient must be a different organization. Use providerDataPackages and recipientDataPackages to declare which categories of data flow to each side, and operator to indicate which organization operates the assets (where the gateways live).

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Asset Sharing under the Asset Sharing category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a Data Sharing Agreement.

string
enum
required

Defines where the gateways will be located. Valid values: provider, recipient

Allowed:
providerDataPackages
array of strings
required

List of data packages the provider will see.

providerDataPackages*
Allowed:
recipientDataPackages
array of strings
required

List of data packages the recipient will see.

recipientDataPackages*
Allowed:
string
required

The ID of the recipient organization.

string
required
length between 3 and 255

The display name to use for the recipient organization.

Responses

Updated about 4 hours ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 hours ago

Did this page help you?