Donation · Forms · Submissions
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.readpermission. - The caller needs the
donationFormSubmission.removepermission. - 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'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/submissions/YOUR_DONATION_FORM_SUBMISSION_ID", {
method: "DELETE",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'DELETE',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/forms/submissions/YOUR_DONATION_FORM_SUBMISSION_ID', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
No response body is specified.
What else happens
- The rejected submission is deleted from
donationFormSubmissions. - The associated donation form’s
rejectedcount is decreased by one.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | This 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. |
| 404 | The 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.