Skip to content

Update an office location​

PATCH
/org-admin/{slug}/locations/{locationId}

Partial update of a location. address, when sent, replaces the whole address object. Setting is_primary: true clears the previous primary in the same transaction.

Requires permission: org.manage_locations

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

slug*

The organization's slug (not its UUID).

Type
string
Required
Example"local-food-bank-a1b2c3"
Pattern
"^[a-z0-9][a-z0-9-]{0,254}$"
locationId*

A non-UUID answers 404 Location not found.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"label": "string",
"address": "string",
"is_primary": true,
"is_publicly_visible": true
}

Responses​

Location updated

application/json
JSON
{
"data": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress