Maintenance Sites

Update a maintenance site

Updates an existing maintenance site for the organization. Moving a site between placeIds and customAddress is not supported.

<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 Maintenance Sites under the Work Orders 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/maintenance/sites

Request

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

Query parameters

idstring required

Unique identifier for the MaintenanceSite record.

Request body

descriptionstring

Description of the maintenance site.

namestring

Name of the maintenance site. Org-unique.

siteCodestring

Org-unique 3-character code for the site, used to generate inventory batch numbers.

siteType'Unknown' | 'CentralWarehouse' | 'MaintenanceShop' | 'MobileServiceVehicle' | 'YardOnsite' | 'Consignment' | 'Other'

Type of maintenance site, for example central warehouse, maintenance shop, or yard/onsite. Valid values: Unknown, CentralWarehouse, MaintenanceShop, MobileServiceVehicle, YardOnsite, Consignment, Other

Example request

{
  "description": "12345",
  "externalIds": [
    {
      "key": "12345",
      "value": "12345"
    }
  ],
  "name": "12345",
  "siteCode": "12345",
  "siteType": "Unknown"
}

Response

OK response.

Example response

{
  "data": {
    "archivedAt": "2019-06-13T19:08:25Z",
    "createdAt": "2019-06-13T19:08:25Z",
    "customAddress": {
      "formattedAddress": "12345",
      "latitude": 123.45,
      "longitude": 123.45
    },
    "description": "12345",
    "externalIds": [
      {
        "key": "12345",
        "value": "12345"
      }
    ],
    "id": "12345",
    "isArchived": true,
    "name": "12345",
    "places": [
      {
        "id": "281474976710656"
      }
    ],
    "siteCode": "12345",
    "siteType": "Unknown",
    "updatedAt": "2019-06-13T19:08:25Z"
  }
}

Changes

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