getPendingEmailsSimple — Retrieving pending emails

The getPendingEmailsSimple method provides message IDs and placeholders for in-dashboard messaging. If you need additional message metadata, use getMessageTypes to retrieve relevant details.

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

getPendingMessages: The method name

before: (Optional) If specified, only messages from before this date will be returned.
after: (Optional) If specified, only messages from after this date will be returned.

account: (Optional) If specified, only messages for this account ID will be returned.

The before and after attributes must be specified in the format YYYY-MM-DD HH:MM:SS, where years are always four digits, all other fields are two digits, and always include a leading zero for single-digit values. Dates not meeting this criteria or dates that cannot be validated will be silently rejected.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>password</password>
    </authentication>
    <getPendingEmailsSimple>
        <before>2012-01-15 06:00:00</before>
        <after>2011-12-25 18:00:00</after>
        <account>234</account>
    </getPendingEmailsSimple>
</SiteLockOnlineRequest>

Response format

The response returns a list of all pending emails based on any criteria you may have specified.

Fixed child elements: A set of elements that is always sent with each response.
- count: The number of emails that met your filter criteria.
- status: The status of your request. The value can be either success or failed. When the value is failed, there will also be an error element containing error text. The error text may vary.
- domain: The user’s domain name
- message_id: Use this to link back to your master table of messages
- email_address: The email ID through which the user prefers to receive notifications—as entered in SiteLock’s settings section.
- language: The five-character language code through which the user prefers to view their dashboard—as selected on the SiteLock Dashboard. The details of the languages that SiteLock supports can be found at this API endpoint:
  https://api.sitelock.com/v1/language/list
queue_id: The unique instance identifier. Use this identifier in the request to markEmailsSent so that SiteLock doesn’t return this email again in a subsequent call to getPendingEmails or getPendingEmailsSimple.
site_id: The SiteLock site ID of the user
account_id: The SiteLock account ID of the user

Dynamic child elements: Dynamic child elements

The dynamic child elements are provided for informational purposes only and partners shouldn’t rely on their continued presence. These elements may be replaced or removed as SiteLock revises its workflows and email templates.

replacements: A collection of replacement elements. These replacements are based on copy that SiteLock uses in its email templates. Your copy may not use any of these, or may have different placeholders.
- replacement: Has the following attributes:
  - name: Corresponds to the placeholder text in the template email.
  - value: The substitute for the placeholder in this instance of the email.

Example success response

<SiteLockOnlineResponse>
    <getPendingEmailsSimple>
        <count>1</count>
        <status>success</status>
        <emails>
            <email>
                <domain>example.com</domain>
                <message_id>33</message_id>
                <email_address>[email protected]</email_address>
                <replacements>
                    <replacement value="example.com" name="site" />
                </replacements>
                <language>en-US</language>
                <queue_id>500000</queue_id>
                <site_id>99009900</site_id>
                <account_id>987655555</account_id>
            </email>
        </emails>
    </getPendingEmailsSimple>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <getPendingEmailsSimple>
        <error>No Messages</error>
        <status>failed</status>
    </getPendingEmailsSimple>
</SiteLockOnlineResponse>

Error codes

Partner not configured for white label email access
No Messages