SAsamsara
Issues

Update a single issue.

Updates an instance of an issue.

<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 Issues 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/issues

Request

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

Request body

descriptionstring

Description of the issue.

dueDatestring date-time

Due date of the issue. UTC timestamp in RFC 3339 format.

externalIdsobject

A map of external ids

idstring required

ID of the issue. Can be either a unique Samsara ID or an external ID for the issue.

priority'low' | 'medium' | 'high'

Priority of the issue. Valid values: low, medium, high

status'open' | 'inProgress' | 'resolved' | 'dismissed'

Status of the issue. Valid values: open, inProgress, resolved, dismissed

titlestring

Title of the issue.

Example request

{
  "assignedTo": {
    "id": "938172",
    "type": "user"
  },
  "description": "8cm scratch detected on front bumper",
  "dueDate": "2019-06-13T19:08:25Z",
  "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
  "media": [
    {
      "base64Payload": "JVBERi0xLjQKJeLjz9MKNSAwIG9iago8PC9GaWx0ZXIv...",
      "mediaType": "application/pdf"
    }
  ],
  "priority": "medium",
  "status": "open",
  "title": "Front bumper scratch"
}

Response

OK response.

Example response

{
  "data": {
    "asset": {
      "entryType": "tracked",
      "id": "281474982859091",
      "name": "trailer 123"
    },
    "assignedTo": {
      "id": "938172",
      "type": "driver"
    },
    "createdAtTime": "2019-06-13T19:08:25Z",
    "description": "Oil spill in left corner of SF1",
    "dueDate": "2019-06-13T19:08:25Z",
    "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
    "issueSource": {
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "type": "form"
    },
    "mediaList": [
      {
        "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "processingStatus": "processing",
        "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
        "urlExpiresAt": "2019-06-13T19:08:25Z"
      }
    ],
    "priority": "high",
    "status": "open",
    "submittedAtTime": "2019-06-13T19:08:25Z",
    "submittedBy": {
      "id": "938172",
      "type": "driver"
    },
    "title": "Oil spill",
    "updatedAtTime": "2019-06-13T19:08:25Z"
  }
}

Changes

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