Skip to main content
POST
/
sandbox
/
outlook_mail
/
{sandbox_id}
/
initialize
Initialize outlook_mail sandbox with data
curl --request POST \
  --url https://api.klavis.ai/sandbox/outlook_mail/{sandbox_id}/initialize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "messages": [
    {
      "title": "Welcome to the Team!",
      "content": {
        "contentType": "HTML",
        "content": "<p>Hi there!</p><p>Welcome to our team. We're excited to have you on board. Please feel free to reach out if you have any questions.</p><p>Best regards,<br>HR Team</p>"
      },
      "to_addresses": [
        "[email protected]"
      ],
      "cc_addresses": [
        "[email protected]",
        "[email protected]"
      ]
    },
    {
      "title": "Q4 Budget Review Meeting",
      "content": {
        "contentType": "Text",
        "content": "Hi,\n\nThis is a reminder about our Q4 budget review meeting scheduled for next Tuesday at 2 PM. Please come prepared with your department's spending reports.\n\nThanks,\nFinance Team"
      },
      "to_addresses": [
        "[email protected]"
      ],
      "cc_addresses": [
        "[email protected]"
      ]
    },
    {
      "title": "Project Alpha - Status Update",
      "content": {
        "contentType": "HTML",
        "content": "<h3>Project Alpha Status Report</h3><p>Current Status: <strong>On Track</strong></p><ul><li>Phase 1: Completed</li><li>Phase 2: 75% complete</li><li>Phase 3: Planning</li></ul><p>Next milestone: December 15th</p>"
      },
      "to_addresses": [
        "[email protected]",
        "[email protected]"
      ],
      "cc_addresses": []
    },
    {
      "title": "Action Required: Security Policy Update",
      "content": {
        "contentType": "Text",
        "content": "IMPORTANT: Please review and acknowledge the updated security policy by end of week.\n\nKey changes:\n- Password complexity requirements\n- 2FA mandatory for all accounts\n- VPN usage guidelines\n\nClick the link in your security portal to acknowledge.\n\nIT Security Team"
      },
      "to_addresses": [
        "[email protected]"
      ],
      "cc_addresses": [
        "[email protected]",
        "[email protected]"
      ]
    },
    {
      "title": "Team Lunch - Friday 12:30 PM",
      "content": {
        "contentType": "HTML",
        "content": "<p>Hey team! </p><p>Let's grab lunch together this Friday at 12:30 PM. I've made a reservation at the Italian place downtown.</p><p>Please RSVP by Wednesday so I can confirm the headcount.</p><p>Looking forward to it!<br>Sarah</p>"
      },
      "to_addresses": [
        "[email protected]"
      ],
      "cc_addresses": [
        "[email protected]"
      ]
    }
  ]
}
EOF
{
  "sandbox_id": "<string>",
  "status": "idle",
  "message": "<string>",
  "records_created": {}
}

Authorizations

Authorization
string
header
required

Your Klavis AI API key.

Path Parameters

sandbox_id
string
required

The unique sandbox identifier

Query Parameters

init_default_data
boolean
default:false

If true, use default test data for initialization

Body

application/json

Complete Outlook Mail sandbox data structure

messages
OutlookMailMessage · object[] | null

List of mail messages

Response

Successful Response

Response model for sandbox initialization

sandbox_id
string
required

Sandbox identifier

status
enum<string>
required

Current status

Available options:
idle,
occupied
message
string
required

Initialization result message

records_created
Records Created · object

Count of records created per object type