Create Live Sharing Link

Create Live Sharing Link.

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

To use this endpoint, select Write Live Sharing Links under the Driver Workflow 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.

POST /live-shares

Create Live Sharing Link

cURL

curl --request POST \
  --url https://api.samsara.com/live-shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example Live Sharing Link name",
  "type": "assetsLocation",
  "assetsLocationLinkConfig": {
    "assetId": "1234",
    "tagIds": [
      "48923049",
      "198349"
    ]
  },
  "description": "Sample description",
  "expiresAtTime": "2020-01-27T07:06:25Z"
}
'

200

{
  "data": {
    "id": "leesdwqjx42dkvp86so",
    "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/7hf4lnu455wep22rtun",
    "name": "Example Live Sharing Link name",
    "type": "assetsLocation",
    "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"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

name · string · required

Name of the Live Sharing Link.

Maximum string length: 255

Example:

"Example Live Sharing Link name"

type · enum<string> · required

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

Available options: assetsLocation, assetsNearLocation, assetsOnRoute

Example:

"assetsLocation"

assetsLocationLinkConfig · object

Configuration details specific to the 'By Asset' Live Sharing Link.

Show child attributes

assetsNearLocationLinkConfig · object

Configuration details specific to the 'By Location' Live Sharing Link.

Show child attributes

assetsOnRouteLinkConfig · object

Configuration details specific to the 'By Recurring Route' Live Sharing Link.

Show child attributes

description · string

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

Maximum string length: 255

Example:

"Sample description"

expiresAtTime · string

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

Example:

"2020-01-27T07:06:25Z"

Response

200

application/json

OK response.

data · object · required

Live Sharing Link object

Show child attributes