Skip to content
campaiDeveloper
campai.com

Dispatch · Documents

POST/{organizationId}/{mandateId}/dispatch/documents/resendWithLimitFailure

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.edit
  • mandate.read
  • getDispatchDocumentReadPermissions(dispatchDocumentQueryProperties.types)

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • typesstring[]required
    receipt donation proof certificate pass booking message mailing applicationForm donationForm contactRule questionnaireForm
  • searchTermstring
  • fromDatestring
  • toDatestring
  • clickedboolean
  • unsubscribedboolean
  • recipientContactid
  • receiptobject
    2 properties
    • idid
    • typestring
      receipt reminder donationReminder returnedPayment cancelation
  • donationobject
    1 property
    • idid
  • bookingobject
    4 properties
    • idid
    • eventIdid
    • resourceIdid
    • renderInternalboolean
  • proofobject
    1 property
    • idid
  • certificateobject
    1 property
    • idid
  • passobject
    2 properties
    • passTemplateIdid
    • issuedPassIdid
  • messageobject
    1 property
    • contactid
  • mailingobject
    2 properties
    • idid
    • contactid
  • applicationFormobject
    2 properties
    • formIdid
    • submissionIdid
  • donationFormobject
    2 properties
    • formIdid
    • submissionIdid
  • contactRuleobject
    2 properties
    • idid
    • contactid
  • questionnaireFormobject
    2 properties
    • formIdid
    • submissionIdid
  • selectionobject
    2 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'

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.