Update a vendor (PATCH)

PATCH/v1/api/store/{team_slug}/vendor/{hash_id}

v1Operation ID v1_public_vendor_update_patch

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_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  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

application/json, required.

• account_numberstring
• default_vendor_notestring
• internal_notesstring
• namestring
• websitestring

  The website address.

Response

200Successful response.

• dataobjectrequired
  Child fields (8)

  • idstringrequired
  • namestring | nullrequired
  • trashedbooleanrequired

    True when the vendor is deleted.

  • account_numberstring | null
  • contactsarray of objects

    Every contact, deleted ones included.

    Fields of each item (18)

    • created_atstring (date-time)required
    • first_namestring | nullrequired
    • idstringrequired
    • is_primarybooleanrequired
    • trashedbooleanrequired

      True when the contact is deleted.

    • updated_atstring (date-time)required
    • customer_idstring

      Customer contacts only.

    • default_receive_smsboolean
    • emailstring | null
    • external_typestring | null
    • faxstring | null
    • fax_countrystring | null
    • is_externalboolean

      True for a contact synced from Shopify; such contacts are read-only.

    • last_namestring | null
    • phonestring | null
    • phone_countrystring | null
    • send_invoiceboolean

      Customer contacts only.

    • vendor_idstring

      Vendor contacts only.

  • default_vendor_notestring | null
  • internal_notesstring | null
  • websitestring | null
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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.

Related

• GETGet a vendor/v1/api/store/{team_slug}/vendor/{hash_id}

Example request

curl

curl -X PATCH '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."  }'

Example response 200

Response

{
  "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
}