# Update a vendor

```http
PUT https://secure.yoprint.com/v1/api/store/{team_slug}/vendor/{hash_id}
```

- API version: v1
- Operation ID: `v1_public_vendor_update_put`
- Section: Purchasing › [Vendors](https://developer.yoprint.com/reference/vendors.md)
- Web page: https://developer.yoprint.com/reference/vendors/v1-vendor-update-put/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Changes the fields you send and returns the vendor. Contacts have their own operations.

We recommend `PUT`: it validates that all provided fields are strings and returns 422 if any type is invalid. `PATCH` accepts the exact same body but skips field validation entirely.

## Permission

Needs the Manage Vendors permission at the level that can update vendors.

## Business rules

- To clear a text field, send an empty string; `null` is ignored (it is dropped before the request is read).

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The vendor's id (`id` from List vendors). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `EDhVUaC6jbLbed`.

## Request body

Content type `application/json`, required.

Fields:

- `account_number` (string, optional)
- `default_vendor_note` (string, optional)
- `internal_notes` (string, optional)
- `name` (string, optional)
- `website` (string, optional): The website address.

### Example request

```bash
curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/vendor/EDhVUaC6jbLbed' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_number": "ACCT-2002",
    "default_vendor_note": "Ship blanks folded, not on hangers."
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `id` (string, required)
  - `name` (string | null, required)
  - `trashed` (boolean, required): True when the vendor is deleted.
  - `account_number` (string | null, optional)
  - `contacts` (array of objects, optional): Every contact, deleted ones included.
    - Each item:
      - `created_at` (string (date-time), required)
      - `first_name` (string | null, required)
      - `id` (string, required)
      - `is_primary` (boolean, required)
      - `trashed` (boolean, required): True when the contact is deleted.
      - `updated_at` (string (date-time), required)
      - `customer_id` (string, optional): Customer contacts only.
      - `default_receive_sms` (boolean, optional)
      - `email` (string | null, optional)
      - `external_type` (string | null, optional)
      - `fax` (string | null, optional)
      - `fax_country` (string | null, optional)
      - `is_external` (boolean, optional): True for a contact synced from Shopify; such contacts are read-only.
      - `last_name` (string | null, optional)
      - `phone` (string | null, optional)
      - `phone_country` (string | null, optional)
      - `send_invoice` (boolean, optional): Customer contacts only.
      - `vendor_id` (string, optional): Vendor contacts only.
  - `default_vendor_note` (string | null, optional)
  - `internal_notes` (string | null, optional)
  - `website` (string | null, optional)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "account_number": "ACCT-2002",
    "contacts": [
      {
        "created_at": "2026-11-01T09:00:00+00:00",
        "default_receive_sms": false,
        "email": "sam@example.com",
        "external_type": null,
        "fax": null,
        "fax_country": null,
        "first_name": "Sam",
        "id": "fopJXRDkZ8Qk7S",
        "is_external": false,
        "is_primary": true,
        "last_name": "Lee",
        "phone": "+1 201 555 0123",
        "phone_country": "US",
        "trashed": false,
        "updated_at": "2026-11-01T09:00:00+00:00",
        "vendor_id": "MFwvMEIK7ud89l"
      }
    ],
    "default_vendor_note": "Ship blanks folded, not on hangers.",
    "id": "MFwvMEIK7ud89l",
    "internal_notes": null,
    "name": "Example Blanks Co",
    "trashed": false,
    "website": "https://example.com"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role cannot update vendors. This 403 has a short body, `{"message": "Insufficient Permission"}`, with no `success` or `error`. Fix: Ask a team owner to raise Manage Vendors for your role.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No live vendor with this id. `error.code` is null and `error.message` names the record type. Fix: Restore a deleted vendor first.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: A field is not a string. `error.code` is `validation_failed`. Fix: Send text fields as strings.

## Related

- [Get a vendor](https://developer.yoprint.com/reference/vendors/v1-vendor-show.md): `GET /v1/api/store/{team_slug}/vendor/{hash_id}`
