Delete an office location

DELETE

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

Permanently deletes a location. Deleting the primary leaves the organization with no primary location.

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"

Responses

Location deleted

DELETE

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

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

slug*

locationId*

Samples

Powered by VitePress OpenAPI