mailSetStatus()

The function mailSetStatus() updates the participation status of a mailing. The status is particularly relevant for sending reminders and follow-up mailings.

void mailSetStatus(string|null personID, int|null mailing, string status)

• personID
  A person ID (SERIAL) or NULL, if the delivery to the current respondent shall be updated.
• mailing
  The ID of a mailing or NULL, if the status of the most recently sent mailing shall be updated.
• status
  • 'sent' – The mailing was sent, but the participation link has not been clicked yet.
  • 'started' – The participation link was clicked, but the questionnaire was not completed.
  • 'complete' – Filling out the questionnaire was completed.
  • 'dismissed' – The person was rejected, e.g., by a screenout or a quota check.

The following PHP code sets the status “questionnaire completed” for the mailing that led the current respondent to the questionnaire.

mailSetStatus(null, null, 'complete');