---
title: "Update vendor"
method: PATCH
path: "/vendors/{id}"
tags: ["Vendors"]
---

# Update vendor

`PATCH /vendors/{id}`

## Path parameters

- `id` integer, required

## Query parameters

- `skipWebhook` boolean

## Request body

- object
  - `name` string
  - `description` string, nullable
  - `extraFields` object — Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Qualifications")

## Response `200`

Successfully edited vendor

- object
  - `vendor` object, required
    - `id` integer, required — Global ID of the vendor
    - `name` string, required
    - `emails` string[] — List of email address
    - `phoneNumbers` string[] — List of phone number
    - `description` string, nullable
    - `thumbnail` object, nullable
      - `id` number, required — Global ID of the attachment
      - `mimeType` string, required — MIME type of the file
      - `fileName` string, required — Attachment's file name
      - `url` string, required — Url of the file. Valid for 60 minutes.
      - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
      - `width` number, nullable — Width if the file is an image
      - `height` number, nullable — Height if the file is an image
    - `attachments` object[] — List of attachments linked to the vendor
      - `id` number, required — Global ID of the attachment
      - `mimeType` string, required — MIME type of the file
      - `fileName` string, required — Attachment's file name
      - `url` string, required — Url of the file. Valid for 60 minutes.
      - `createdAt` string, date-time, required — Date & time at which the attachment was uploaded
      - `width` number, nullable — Width if the file is an image
      - `height` number, nullable — Height if the file is an image
    - `contactIds` integer[] — List of contact IDs
    - `deletedAt` string, date-time, nullable — Date that the vendor was deleted
    - `extraFields` object — Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Qualifications")

## Other responses

- `400` — Failed to edit the vendor
- `401` — Invalid token
- `404` — Could not find the specified vendor.

---

[API](https://skmtc.net/getmaintainx/apis/maintainx-api.md) · [All operations](https://skmtc.net/getmaintainx/apis/maintainx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getmaintainx/maintainx-api/revisions/ef9153fcac7c/schema)