Skip to content
campaiDeveloper
campai.com

Donation · Forms · Submissions

POST/{organizationId}/{mandateId}/donation/forms/submissions/{donationFormSubmissionId}/markAsRead

Mark submission read

Marks a donation form submission as read or unread. Supply the organization, mandate and submission IDs and a read boolean. The mutation returns no value.

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 organization access.
  • The caller needs mandate.read permission.
  • The caller also needs donationFormSubmission.edit permission.
  • The submission lookup applies a mandate access filter.
  • The submission lookup also applies an assigned-only access filter using the caller's user ID, if available.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • donationFormSubmissionIdidrequired

Body

Content-Type: application/json

  • readbooleanrequired
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/donation/forms/submissions/YOUR_DONATION_FORM_SUBMISSION_ID/markAsRead' \
  --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

No response body is specified.

What else happens

  • On success, the submission status changes from unread to pending when read is true, or from pending to unread when it is false.
  • The donation form's count for the old status is decreased by one, and its count for the new status is increased by one.

Errors

Other errors

StatusErrorWhen
400This submission can not be changed in its current status.If the submission is not unread when read is true, or not pending when read is false, the endpoint returns 400 with routes.donation.forms.invalidStatus.
404The submission was not found.If no submission matches the lookup, the endpoint returns 404 with routes.donation.forms.submissionNotFound.

Errors nearly every request can meet are listed under Errors.