Skip to content

Edit a resource​

PATCH
/resources/{id}

A draft saves freely. On published help, small fields go live at once (audit-logged) and material fields open or replace the one pending revision while the live version stays up. The schema's rules are checked now, revision included. A stale version gets 409 stale_version with details.changed_since (the fields, and whether staff changed them). Checks: requireProviderAccess('manage_resources').

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​

Header Parameters

If-Match

The version you opened, e.g. "7". Or send version in the body.

Type
string

Path Parameters

id*

The resource.

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"title": "string",
"summary": "string",
"details": "string",
"topic_ids": [
"string"
],
"primary_topic_id": "string",
"need_ids": [
"string"
],
"cost_model": "string",
"fee_min_cents": 0,
"fee_max_cents": 0,
"audience": "string",
"faith_participation": true,
"faith_note": "string",
"eligibility": [
"string"
],
"income_limit_pct_fpl": 0,
"how_to_start": [
"string"
],
"apply_url": "string",
"phone": "string",
"languages": [
"string"
],
"referral_required": true,
"referral_note": "string",
"delivery": "string",
"stock_note": "string",
"capacity": "string",
"capacity_note": "string",
"paused_until": "string",
"online": true,
"confidential_address": true,
"hours_source": "string",
"hours": [
{
"weekday": 0,
"opens_at": "09:00",
"closes_at": "17:00"
}
],
"hours_exceptions": [
{
"starts_on": "string",
"ends_on": "string",
"opens_at": "string",
"closes_at": "string",
"reason": "string"
}
],
"location_ids": [
"string"
],
"service_areas": [
{
"place_id": "string",
"state_code": "string",
"nationwide": true,
"country": "string"
}
],
"license_ids": [
"string"
],
"version": 0
}

Responses​

OK

application/json
JSON
{
"resource": "string",
"changed": [
"string"
],
"applied": [
"string"
],
"in_review": [
"string"
]
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress