Record a bulk-import wizard completion
/portal/v1/accounts/{accountSlug}/applications/{appSlug}/identities/bulk-import-eventsAuthentication
- Bearer Token
AuthorizationJWT access token
Request body
mode *enum: "create" | "invite"total *numberTotal rows the wizard processed (succeeded + failed).
succeeded *numberfailed *numberskippednumberRows the admin explicitly skipped (deselected in the preview, or unsent after a cancel).
Code samples
curl -X POST "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/identities/bulk-import-events" \
-H "Authorization: Bearer $CANOPY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"mode": "create",
"total": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0
}'const response = await fetch("https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/identities/bulk-import-events", {
method: "POST",
headers: {
"Authorization": "Bearer $CANOPY_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({
"mode": "create",
"total": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/identities/bulk-import-events",
headers={
"Authorization": "Bearer $CANOPY_TOKEN",
"Content-Type": "application/json"
},
json={
"mode": "create",
"total": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0,
},
)
data = response.json()package main
import (
"bytes"
"encoding/json"
"net/http"
)
func main() {
payload := map[string]interface{}{
"mode": "create",
"total": 0,
"succeeded": 0,
"failed": 0,
"skipped": 0,
}
body, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/identities/bulk-import-events", bytes.NewBuffer(body))
req.Header.Set("Authorization", "Bearer $CANOPY_TOKEN")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
}Responses
204 Bulk-import wizard fired its completion event. Surfaces a single audit-log entry summarising the wizard run (mode, totals) so admins can ask 'did anyone run a bulk import this week?' without correlating per-batch events.
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)