End a live campaign

POST

/fundraisers/{id}/end

Ends a live campaign now, below its goal or not. Donations stay open unless keep_donations_open is false. The owner or a platform admin. 409 codes: ALREADY_ENDED, PAUSED, NOT_ACTIVE.

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

{

"keep_donations_open": true

}

Responses

The campaign after the change, with its fundraising state

Content-Type

application/json

{

"data": {

"fundraising": "string"

}

}

POST

/fundraisers/{id}/end

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

id*

Body

Samples

Powered by VitePress OpenAPI