1. Docs
  2. API Reference
  3. Record a bulk-import wizard completion

Record a bulk-import wizard completion

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/identities/bulk-import-events

Authentication

  • Bearer Token Authorization

    JWT access token

Request body

  • modeenum: "create" | "invite"*
  • totalnumber*

    Total rows the wizard processed (succeeded + failed).

  • succeedednumber*
  • failednumber*
  • skippednumber

    Rows the admin explicitly skipped (deselected in the preview, or unsent after a cancel).

Code samples

cURLJavaScriptPythonGo
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
  }'

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)
On this page

Related endpoints

GETList identities in Application
POSTCreate an identity
GETList identities with their role assignments
GETGet Application identities summary
POSTBulk-create identities
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
POSTActivate an identity
POSTDeactivate an identity
GETGet identity's role assignments
GETGet identity's effective permissions