SAsamsara
Forms

Update a single form submission.

Updates an instance of a form submission.

<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 Form Submissions under the Forms 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.

patch/form-submissions

Request

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

Request body

dueAtTimestring date-time

Due date of the form submission. UTC timestamp in RFC 3339 format.

idstring required

ID of the form submission.

isRequiredboolean

Indicates whether the worker is required to complete this form or not at a specific route stop. Defaults to true if the form is assigned to a user or driver. When true, the worker cannot depart the route stop until this form submission is submitted.

routeStopIdstring

ID of the route stop the form submission is assigned to. Must be a unique Samsara ID.

status'notStarted' | 'archived' | 'inProgress' | 'changesRequested' | 'approved' | 'denied'

Status of the form submission. Valid values: notStarted, archived, inProgress, changesRequested, approved, denied

titlestring

Title of the form submission.

Example request

{
  "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac8",
  "status": "notStarted"
}

Response

OK response.

Changes

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