Skip to content

Edit my Fundly's success story​

PATCH
/fundraisers/{id}/success-story

The owner edits their story directly, in every status but hidden (409 INVALID_STATUS). headline, dek and ask_excerpt may change only before publish (409 PUBLISHED_FIELD_LOCKED after; sending the unchanged value is fine). Before publish, any change clears organizer_approved_at (an approved story goes back to organizer_review). On a published story the edit is live at once, audit-logged with the old and new values, and staff are notified.

photo_url must be an image uploaded through POST /storage/upload (bucket fundraiser-images), the same check the campaign media uses. ask_excerpt must be quoted word for word from the Fundly's own story (400 VALIDATION_ERROR). Send only the fields that change; null or an empty string clears a text field.

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

id*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"headline": "string",
"dek": "string",
"ask_excerpt": "string",
"money_text": "string",
"breakdown": [
],
"photo_url": "string",
"photo_caption": "string",
"now_text": "string",
"gifts_purpose": "string"
}

Responses​

The story after the edit

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress