Create ZapPulse Report Share Link

POST

/zappulse/mailboxes/{mailboxId}/share

Creates a read-only share link for a mailbox report. Open https://app.zapmail.ai/share/zappulse/{token} to view the report without logging in. The link is valid for 30 days and only shows this mailbox. Pass runId to share a specific test instead of the latest one. The token cannot be used with other API endpoints.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Share token created

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zapmail.ai/api/zappulse/mailboxes//share' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'Content-Type: application/json' \
--data '{
    "runId": "78c33d18-170c-44d3-a227-b3194f134f73"
}'

Response Example

{
    "status": 0,
    "message": "string",
    "data": {
        "token": "string",
        "expiresAt": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-11-10 12:00:32

Get ZapPulse Mailbox Report

domain with filter