Beta APIs

[beta] Publish a driver app workflow to drivers

Publish or unpublish a driver app workflow to one or more drivers by their IDs. If a workflow is published to a driver who already has it, or unpublished from a driver who does not have it, the operation is a no-op for that driver.

<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Driver App Settings under the Drivers 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/fleet/drivers/workflow-assignments

Request

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

Request body

driverIdsToPublishstring[]

List of driver IDs to publish the workflow to. If a driver already has the workflow, the operation is a no-op for that driver.

driverIdsToUnpublishstring[]

List of driver IDs to unpublish the workflow from. If a driver does not have the workflow, the operation is a no-op for that driver.

workflowIdstring required

The UUID of the workflow to publish.

Example request

{
  "driverIdsToPublish": [
    "12434",
    "12434",
    "12434"
  ],
  "driverIdsToUnpublish": [
    "56789",
    "56789",
    "56789",
    "56789"
  ],
  "workflowId": "a4db8702-79d5-4396-a717-e301d52ecc11"
}

Response

OK response.

Example response

{
  "data": {
    "workflowId": "a4db8702-79d5-4396-a717-e301d52ecc11"
  }
}

Changes

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