Donation ยท Campaigns
Delete donation campaign
Deletes a donation campaign for the specified organization and mandate, using organizationId, mandateId, and campaignId. A campaign linked to donations, forms, or contracts cannot be deleted. On success, the endpoint returns an empty object.
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.readpermission. - The caller also needs
donationsSettings.editpermission.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
campaignIdidrequired
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/campaigns/YOUR_CAMPAIGN_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/donation/campaigns/YOUR_CAMPAIGN_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/campaigns/YOUR_CAMPAIGN_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
Content-Type: application/json
Response200
{}
What else happens
- If the campaign exists and is not in use, it is deleted from
donationCampaigns.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 400 | The campaign has donations, forms or contracts and can not be deleted. Make it unavailable instead. | If a donation in the mandate references the campaign, the endpoint returns HTTP 400 with routes.donation.campaigns.campaignInUse. |
| 400 | The campaign has donations, forms or contracts and can not be deleted. Make it unavailable instead. | If a form or contract references the campaign, the endpoint returns HTTP 400 with routes.donation.campaigns.campaignInUse. |
| 404 | The campaign was not found. | If the campaign is not found in the organization and mandate, the endpoint returns HTTP 404 with routes.donation.campaigns.campaignNotFound, provided no linked donation, form, or contract was found first. |
| 404 | A mandate needs to be provided | If mandateId is a null object ID, the endpoint returns HTTP 404 with organization.getMandate.nullMandateId. |
| 404 | Mandate mandate ID not found | If the mandate is not found in the organization, the endpoint returns HTTP 404 with organization.getMandate.notFound. |
Marked words such as mandate ID are filled in with the actual value when the error happens.
Errors nearly every request can meet are listed under Errors.