logo
ReportsAdd report recipient

Add report recipient

Add a new recipient who can receive generated reports. Each recipient can have an optional delivery schedule.

  • Set reportType to campaign and provide campaignIds (max 10) for campaign-specific reports.
  • Set reportType to workspace for workspace-wide reports.
  • Enable schedule to automatically generate and deliver reports on a recurring basis.

Duplicate emails within the same workspace are rejected.

curl -X POST "https://api.sendkit.ai/v1/reports/recipients" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "company": "Acme Inc",
  "role": "CEO",
  "reportType": "campaign",
  "campaignIds": [
    "664f0a1b2c3d4e5f6a7b8c01"
  ],
  "schedule": {
    "enabled": true,
    "frequency": "weekly",
    "dayOfWeek": 1,
    "timeOfDay": "09:00",
    "timezone": "America/New_York"
  }
}'
{
  "success": true,
  "data": {
    "_id": "666f1a2b3c4d5e6f7a8b9c20",
    "name": "Jane Smith",
    "email": "jane@example.com",
    "company": "Acme Inc",
    "role": "CEO",
    "reportType": "campaign",
    "campaignIds": [
      "664f0a1b2c3d4e5f6a7b8c01"
    ],
    "active": true,
    "schedule": {
      "enabled": true,
      "frequency": "weekly",
      "dayOfWeek": 1,
      "dayOfMonth": 1,
      "timeOfDay": "09:00",
      "timezone": "America/New_York",
      "nextScheduledAt": "2026-04-21T09:00:00.000Z"
    },
    "totalReportsSent": 0,
    "createdAt": "2026-04-17T10:00:00.000Z",
    "updatedAt": "2026-04-17T10:00:00.000Z"
  }
}
POST
/v1/reports/recipients
POST
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Recipient's full name

emailstring
Required

Recipient's email address (must be unique per workspace)

Format: email
companystring

Recipient's company name

rolestring

Recipient's role or title

reportTypestring

Type of report this recipient receives

Options: workspace, campaign
campaignIdsarray

Campaign IDs for campaign-type reports (required when reportType is campaign, max 10)

scheduleobject

Optional recurring delivery schedule. When enabled, reports are auto-generated and sent on the specified schedule.

sendingMailboxIdstring

Mailbox ID to send reports from

slackChannelIdstring

Slack channel ID for report notifications

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Body

application/json
namestring
Required

Recipient's full name

emailstring
Required

Recipient's email address (must be unique per workspace)

companystring

Recipient's company name

rolestring

Recipient's role or title

reportTypestring

Type of report this recipient receives

Allowed values:workspacecampaign
campaignIdsarray

Campaign IDs for campaign-type reports (required when reportType is campaign, max 10)

scheduleobject

Optional recurring delivery schedule. When enabled, reports are auto-generated and sent on the specified schedule.

sendingMailboxIdstring

Mailbox ID to send reports from

slackChannelIdstring

Slack channel ID for report notifications

Responses