Update site

PATCH

/api/sites/{id}

curl --request PATCH \
  --url http://localhost:3000/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "name": "example", "slug": "example", "status": "active", "regionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "facility": "example", "latitude": 1, "longitude": 1, "description": "example" }'

• Local development
• Dedicated / self-hosted instance

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body ^required

Media type application/json

object

name

string

slug

Auto-generated from name when omitted

string

status

string

default: active

Allowed values: active planned retired

regionId

string format: uuid

facility

string

latitude

number

>= -90 <= 90

longitude

number

>= -180 <= 180

description

string

Responses

200

Site updated

Media type application/json

object

data

object

id

required

string format: uuid

name

required

string

slug

string

nullable

status

required

string

Allowed values: active planned retired

regionId

string format: uuid

nullable

facility

string

nullable

latitude

Decimal degrees, numeric(9,6) serialised as string

string

nullable

longitude

Decimal degrees, numeric(9,6) serialised as string

string

nullable

description

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": {
    "status": "active"
  }
}

400

Validation error

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}

401

Not authenticated

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}

404

Site not found

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}