Reference · PATCH /v1/sites/:id

Update site

Modify a site you own. Send only the fields you want to change. Returns 204 No Content on success.

Request

curl -X PATCH -H "Authorization: Bearer fi_pk_…" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "198 Shirley Street, Pimpama QLD 4209",
    "notes": "New gate code: 1742#"
  }' \
  https://<host>/v1/sites/3065756

Response

HTTP/1.1 204 No Content

Fields

business_name

string

Replace the display name. ≤ 200 chars.

address

string

Replace the address. Example: `"198 Shirley Street, Pimpama QLD 4209"`. ≤ 500 chars.

first_name

string

Replace the site contact’s first name. ≤ 100 chars.

last_name

string

≤ 100 chars.

mobile_number

string

Replace the contact phone. ≤ 50 chars.

email

string

Replace the contact email. ≤ 200 chars.

notes

string

Replace the notes (full overwrite). Example: `"New gate code: 1742#"`. ≤ 2000 chars.

url

string

Replace the URL. ≤ 500 chars.

external_id

string

Replace your reference. ≤ 36 chars.

Errors

400 invalid-body401 unauthorized404 not-found429 rate-limited

A site’s customer can’t be reassigned via the API — create a new site under the right customer instead. 404 covers both 'no such site' and 'this site isn’t yours' — they look the same from the outside.