Skip to content

Stop donations to an ended campaign​

POST
/fundraisers/{id}/stop-donations

Stops fundraising on an ended campaign: nobody can donate after this, and the donate action becomes find_similar. A live campaign whose end date has passed is ended by its deadline in the same step. The owner or a platform admin. 409 codes: ALREADY_STOPPED, NOT_ENDED.

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"

Responses​

The campaign after the change, with its fundraising state

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

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress