Update a staff member

A patch: omitted fields are left alone. A row backed by a signed-in account keeps its name in step with that account, so a rename here can be overwritten.

Errors

404 staff_not_found — unknown ID, or one belonging to another tenant.
422 staff_name_required — name present but blank.
422 invalid_rate — a negative rate.

PATCH/api/v1/staff/{id}

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Path parameters

idstringrequired

Request body

requiredapplication/json

namestring

The person's name. Required to create.

hourlyRatenumber

Pay per hour in the tenant's currency, used to cost an event's labour. Must not be negative.

mileageRatenumber

Pay per mile in the tenant's currency, used to cost travel. Must not be negative.

addressstring

Where they travel from

emailstring

Contact email.

phonestring

Contact number.

companyNamestring

Their company

websitestring

Their website

Responses

200Updated

staffIdstringrequired

namestringrequired

hourlyRatenumber | null

mileageRatenumber | null

addressstring | null

emailstring | null

phonestring | null

companyNamestring | null

websitestring | null

hasAccountbooleanrequired

True when this row belongs to a signed-in member. Those rows can't be deleted over the API.

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

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

namestringThe person's name. Required to create.hourlyRatenumberPay per hour in the tenant's currency, used to cost an event's labour. Must not be negative.mileageRatenumberPay per mile in the tenant's currency, used to cost travel. Must not be negative.addressstringWhere they travel fromemailstringContact email.phonestringContact number.companyNamestringTheir companywebsitestringTheir website

Request

curl -X PATCH "https://app.bloomcount.com/api/v1/staff/stf_r4t7v2x9z1b6n3q8w5y0m2k7" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "hourlyRate": 0,
  "mileageRate": 0,
  "address": "string",
  "email": "string",
  "phone": "string",
  "companyName": "string",
  "website": "string"
}'

const response = await fetch("https://app.bloomcount.com/api/v1/staff/stf_r4t7v2x9z1b6n3q8w5y0m2k7", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"hourlyRate\": 0,\n  \"mileageRate\": 0,\n  \"address\": \"string\",\n  \"email\": \"string\",\n  \"phone\": \"string\",\n  \"companyName\": \"string\",\n  \"website\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://app.bloomcount.com/api/v1/staff/stf_r4t7v2x9z1b6n3q8w5y0m2k7",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"hourlyRate\": 0,\n  \"mileageRate\": 0,\n  \"address\": \"string\",\n  \"email\": \"string\",\n  \"phone\": \"string\",\n  \"companyName\": \"string\",\n  \"website\": \"string\"\n}",
)

Response

{
  "staffId": "stf_r4t7v2x9z1b6n3q8w5y0m2k7",
  "name": "Priya Raman",
  "hourlyRate": 22.5,
  "mileageRate": 0.45,
  "address": null,
  "email": "priya@example.com",
  "phone": null,
  "companyName": null,
  "website": null,
  "hasAccount": false
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}