SAsamsara
Live Sharing Links

Create Live Sharing Link

Create Live Sharing Link.

<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 Live Sharing Links under the Driver Workflow 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.

post/live-shares

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

descriptionstring

Description for the Live Sharing Link (not applicable for 'assetsOnRoute' type).

expiresAtTimestring

Date that this link expires in RFC 3339 format. Can't be set in the past. If not provided then link will never expire.

namestring required

Name of the Live Sharing Link.

type'assetsLocation' | 'assetsNearLocation' | 'assetsOnRoute' required

Type of the Live Sharing Link. This field specifies which one of '<type>LinkConfig' objects will be used to configure the sharing link. Valid values: assetsLocation, assetsNearLocation, assetsOnRoute

Example request

{
  "assetsLocationLinkConfig": {
    "assetId": "1234",
    "location": {
      "formattedAddress": "1990 Alameda Street, San Francisco, CA 94103",
      "latitude": 37.456345,
      "longitude": 34.5633749,
      "name": "Suburbs"
    },
    "tagIds": [
      "48923049",
      "198349"
    ]
  },
  "assetsNearLocationLinkConfig": {
    "addressId": "1234"
  },
  "assetsOnRouteLinkConfig": {
    "recurringRouteId": "1234"
  },
  "description": "Sample description",
  "expiresAtTime": "2020-01-27T07:06:25Z",
  "name": "Example Live Sharing Link name",
  "type": "assetsLocation"
}

Response

OK response.

Example response

{
  "data": {
    "assetsLocationLinkConfig": {
      "assetId": "1234",
      "location": {
        "formattedAddress": "1990 Alameda Street, San Francisco, CA 94103",
        "latitude": 37.456345,
        "longitude": 34.5633749,
        "name": "Suburbs"
      },
      "tags": [
        {
          "id": "3914",
          "name": "East Coast",
          "parentTagId": "4815"
        }
      ]
    },
    "assetsNearLocationLinkConfig": {
      "addressId": "1234"
    },
    "assetsOnRouteLinkConfig": {
      "recurringRouteId": "1234"
    },
    "description": "Sample description",
    "expiresAtTime": "2020-01-27T07:06:25Z",
    "id": "leesdwqjx42dkvp86so",
    "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/7hf4lnu455wep22rtun",
    "name": "Example Live Sharing Link name",
    "type": "assetsLocation"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.