Update a supplier

A patch: omitted fields are left alone, so sending {"contactPhone": "+44 117 496 0000"} changes nothing else. Pass null to clear a contact field.

Errors

409 default_supplier_immutable — the hidden Default supplier can’t be edited.
409 supplier_name_taken — the new name belongs to another supplier on the tenant.
422 supplier_name_required — name present but blank.
404 supplier_not_found — unknown, archived, or another tenant’s.

PATCH/api/v1/suppliers/{id}

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Path parameters

idstringrequired

Request body

requiredapplication/json

namestring

addressstring

websitestring

contactNamestring

contactEmailstring

contactPhonestring

Responses

200Updated

supplierIdstringrequired

namestringrequired

contactNamestring | null

contactEmailstring | null

contactPhonestring | null

websitestring | null

addressstring | null

401Missing or invalid API key, or revoked / expired.

errorstringrequired

403Authenticated, but the key lacks the required scope or the tenant has no API access.

errorstringrequired

404The requested resource doesn't exist or belongs to a different tenant.

errorstringrequired

409The request is well formed, but it conflicts with the current state: a name already taken, a row the app protects (the hidden Default supplier, a preset colour or category), or a staff member who has an account.

errorstringrequired

422Request body or arguments failed validation.

errorstringrequired

429Per-minute rate limit (60/min) or per-month cap exceeded.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (bloomcount_...)Remember on this deviceInclude my values in samples

Parameters

idpath*

Bodyapplication/json

namestringaddressstringwebsitestringcontactNamestringcontactEmailstringcontactPhonestring

Request

curl -X PATCH "https://app.bloomcount.com/api/v1/suppliers/sup_77p3v2k6m4t1r5z9c8w0y7b3" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "contactEmail": "neworders@gardenbros.example"
}'

const response = await fetch("https://app.bloomcount.com/api/v1/suppliers/sup_77p3v2k6m4t1r5z9c8w0y7b3", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"contactEmail\": \"neworders@gardenbros.example\"\n}"
});

import requests

response = requests.patch(
    "https://app.bloomcount.com/api/v1/suppliers/sup_77p3v2k6m4t1r5z9c8w0y7b3",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"contactEmail\": \"neworders@gardenbros.example\"\n}",
)

Response

{
  "supplierId": "sup_77p3v2k6m4t1r5z9c8w0y7b3",
  "name": "GardenBros Wholesale",
  "contactName": "Aly Bardon",
  "contactEmail": "neworders@gardenbros.example",
  "contactPhone": null,
  "website": "https://gardenbros.example",
  "address": null
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}