Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Vendors

Update vendor

patch/vendors/{id}

Path parameters

idinteger required

ID of the vendor

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Request body

namestring
descriptionstring nullable
extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Qualifications")

Example request

{
  "name": "Acme Corp",
  "description": "Provider of Acme service",
  "extraFields": {
    "Qualifications": "ISO 000"
  }
}

Response

Successfully edited vendor

Example response

{
  "vendor": {
    "id": 963,
    "name": "Acme Corp",
    "emails": [
      "vendor@example.com"
    ],
    "phoneNumbers": [
      "415-555-0100"
    ],
    "description": "Provider of Acme service",
    "thumbnail": {
      "id": 12345,
      "mimeType": "image/png",
      "fileName": "image.png",
      "url": "http://example.com/image.png",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "width": 220,
      "height": 100
    },
    "attachments": [
      {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      }
    ],
    "contactIds": [
      1,
      4,
      13
    ],
    "deletedAt": "2022-01-01T00:00:00.000Z",
    "extraFields": {
      "Qualifications": "ISO 000"
    }
  }
}