Dispatch · Documents
Resend held letters
Resends letters that were not sent because the organization reached its letters limit, e.g. after the limit was raised
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
dispatchDocument.editmandate.readgetDispatchDocumentReadPermissions(dispatchDocumentQueryProperties.types)
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
typesstring[]requiredreceiptdonationproofcertificatepassbookingmessagemailingapplicationFormdonationFormcontactRulequestionnaireForm -
searchTermstring -
fromDatestring -
toDatestring -
clickedboolean -
unsubscribedboolean -
recipientContactid -
receiptobject2 properties
-
idid -
typestringreceiptreminderdonationReminderreturnedPaymentcancelation
-
-
donationobject1 property
-
idid
-
-
bookingobject4 properties
-
idid -
eventIdid -
resourceIdid -
renderInternalboolean
-
-
proofobject1 property
-
idid
-
-
certificateobject1 property
-
idid
-
-
passobject2 properties
-
passTemplateIdid -
issuedPassIdid
-
-
messageobject1 property
-
contactid
-
-
mailingobject2 properties
-
idid -
contactid
-
-
applicationFormobject2 properties
-
formIdid -
submissionIdid
-
-
donationFormobject2 properties
-
formIdid -
submissionIdid
-
-
contactRuleobject2 properties
-
idid -
contactid
-
-
questionnaireFormobject2 properties
-
formIdid -
submissionIdid
-
-
selectionobject2 properties
-
excludeIdsid[]1–1000 items
-
idsid[]1–1000 items
-
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/dispatch/documents/resendWithLimitFailure' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/dispatch/documents/resendWithLimitFailure", {
method: "POST",
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' => 'POST',
'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/dispatch/documents/resendWithLimitFailure', 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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
countinteger
Response200
{
"count": 1
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.