Skip to content
campaiDeveloper
campai.com

Donation · Forms · Submissions

DELETE/{organizationId}/{mandateId}/donation/forms/submissions/{donationFormSubmissionId}

Delete donation form submission

Deletes a rejected donation form submission identified by its organization, mandate, and submission IDs. It also decreases the donation form’s rejected count. The endpoint returns no response body.

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 the mandate.read permission.
  • The caller needs the donationFormSubmission.remove permission.
  • The submission lookup applies the mandate access filter.
  • The submission lookup applies the assigned-only access filter.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • donationFormSubmissionIdidrequired
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/submissions/YOUR_DONATION_FORM_SUBMISSION_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

No response body is specified.

What else happens

  • The rejected submission is deleted from donationFormSubmissions.
  • The associated donation form’s rejected count is decreased by one.

Errors

Other errors

StatusErrorWhen
400This submission can not be changed in its current status.If the submission is not rejected, the endpoint returns HTTP 400 with key routes.donation.forms.invalidStatus.
404The submission was not found.If no matching submission is found, the endpoint returns HTTP 404 with key routes.donation.forms.submissionNotFound.

Errors nearly every request can meet are listed under Errors.