Skip to content
campaiDeveloper
campai.com

Donation ยท Forms

DELETE/{organizationId}/{mandateId}/donation/forms/{donationFormId}

Delete donation form

Deletes a donation form identified by organizationId, mandateId, and donationFormId. A form with submissions cannot be deleted; a successful deletion returns no content.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have access to the organization.
  • The caller needs mandate.read and donationForm.remove permissions.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • donationFormIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request DELETE 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/YOUR_DONATION_FORM_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

No response body is specified.

What else happens

  • If the form exists and has no submissions, it is removed from donationForms.

Errors

Other errors

StatusErrorWhen
400The form has submissions and can not be deleted. Make it unavailable instead.If the form has submissions, the endpoint returns HTTP 400 with key routes.donation.forms.deleteForm.hasSubmissions. The form can be made unavailable instead.
404The donation form was not found.If the form is not found, the endpoint returns HTTP 404 with key routes.donation.forms.formNotFound.

Errors nearly every request can meet are listed under Errors.