SAsamsara
Beta APIs

[beta] Update a vendor

Manage parent vendor identity and defaults inherited by vendor locations.

<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 Work Orders 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/fleet/maintenance/vendors

Request

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

Query parameters

includeExternalIdsboolean

Include externalIds in the response. Defaults to false.

idstring required

Unique identifier for the vendor record.

Request body

isMobileboolean

Whether vendor locations inherit mobile service as their default.

isPreferredboolean

Default preferred status inherited by vendor locations.

namestring

Name of the vendor profile.

status'active' | 'inactive' | 'unknown'

Own lifecycle status. Defaults to active. Unknown is read-only. Valid values: active, inactive, unknown

Example request

{
  "assetAttributeSelections": [
    {
      "attributeId": "12345",
      "values": [
        {
          "id": "12345"
        }
      ]
    }
  ],
  "defaultLaborRatePerHour": {
    "amount": "12345",
    "currency": "12345"
  },
  "externalIds": [
    {
      "key": "12345",
      "value": "12345"
    }
  ],
  "isMobile": true,
  "isPreferred": true,
  "name": "12345",
  "primaryCorporateContact": {
    "email": "12345",
    "name": "12345",
    "phoneNumber": "12345"
  },
  "status": "active"
}

Response

OK response.

Example response

{
  "data": {
    "assetAttributeSelections": [
      {
        "attributeId": "12345",
        "values": [
          {
            "id": "12345"
          }
        ]
      }
    ],
    "createdAtTime": "2019-06-13T19:08:25Z",
    "defaultLaborRatePerHour": {
      "amount": "12345",
      "currency": "12345"
    },
    "externalIds": [
      {
        "key": "12345",
        "value": "12345"
      }
    ],
    "id": "12345",
    "isMobile": true,
    "isPreferred": true,
    "name": "12345",
    "primaryCorporateContact": {
      "email": "12345",
      "name": "12345",
      "phoneNumber": "12345"
    },
    "status": "active",
    "updatedAtTime": "2019-06-13T19:08:25Z"
  }
}

Changes

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