markEmailsSent — Marking emails sent

If you want to send notifications and emails generated by SiteLock directly to your customers, the markEmailsSent request will mark sent messages which you have already dispatched, and prevent them from reappearing in your pending emails queue.

Your account must be configured for email white-labeling before you can make calls to this API.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

  • SiteLockOnlineRequest: This element is used to delineate the full API request.

    • authentication: The partner’s username, password, and branding

      • username: The partner’s API username

      • password: The partner’s API password

      • partner: (Optional) The brand name to use in messaging

    • markEmailsSent: The method name

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <markEmailsSent>
        <queue_id>123</queue_id >
        <queue_id >456</queue_id >
    </markEmailsSent>
</SiteLockOnlineRequest>

Response format

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • markEmailsSent: The method name

      • status: Can be one of the following:

        • success: If all message IDs were marked as sent

        • mixed: If at least one message succeeded but errors were encountered with others

        • failed: If none of the messages could be marked as sent

          For the first two conditions, there’s nothing that needs to be done. The third condition generally shouldn’t occur, but if it does, please contact us immediately.

      • errors: A list of errors if status is failed

        • error: (Repeatable) An error

          • queue_id: The ID of the pending emails queue

          • reason: The error messages can be distinguished by the three-character code:

            • AMS: Already marked as sent

            • QNV: Queue ID not valid

            • IQE: An internal error prevented the operation from succeeding.

            • Partner not configured for white label email access

Example success response

<SiteLockOnlineResponse>
    <markEmailsSent>
        <status>success</status>
    </markEmailsSent>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <markEmailsSent>
        <errors>
            <error>
                <queue_id>27916</queue_id>
                <reason>AMS: Already marked as sent</reason>
            </error>
        </errors>
        <status>failed</status>
    </markEmailsSent>
</SiteLockOnlineResponse>

Example mixed response

<SiteLockOnlineResponse>
    <markEmailsSent>
        <errors>
            <error>
                <queue_id>27678</queue_id>
                <reason>QNV: Queue ID not valid</reason>
            </error>
            <error>
                <queue_id>22678</queue_id>
                <reason>AMS: Already marked as sent</reason>
            </error>
        </errors>
        <status>mixed</status>
    </markEmailsSent>
</SiteLockOnlineResponse>