1. Docs
  2. API Reference
  3. Bulk-create invites

Bulk-create invites

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/identity-invites/bulk-create

Creates many identity invites in one call against the active Environment. This is a partial-success endpoint: each row is processed independently, so per-row business errors (including same-batch duplicates) fold into a failures array rather than aborting the batch. Returns 200 when every row succeeds and 207 Multi-Status when any row fails, with successful rows carrying their own accept_url. Authorization is evaluated once up front. Supports an optional Idempotency-Key header for safe retries.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability env_identities.manageDeveloper Console

Create, invite, edit, and remove identities and assign their roles. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Production Environments require production_identities.accessDeveloper Console

Access identities in production Environments. Applies to users only, and only in an Environment marked production: its identities are real end users. API keys and identity principals are exempt.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Headers

  • Idempotency-Key

    Optional opaque string the server uses to deduplicate retried requests. When the same key is replayed within 24 hours, the original response (status + body) is returned without re-processing — eliminates duplicate writes from network blips between server commit and client receipt. Generate one per logical operation (UUIDv4 recommended). Max 255 characters.

Request body

application/json

invitesCreateIdentityInviteDto[] Required

Responses

application/json

  • summaryobject*
  • resultsobject[]*

application/json

  • summaryobject*
  • results("success" | "error")[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

403environment.production_identities_forbiddenForbidden
When it happens

The Environment is marked production and the caller is a user without production identity access.

Remediation

Manage these people in the Admin Workspace, or ask an administrator to grant the Production Support role, then retry.

Idempotency

Idempotency-Key header

Send an Idempotency-Key header to make retries safe. Canopy replays the same response for matching keys within 24 hours, and refuses the same key sent with a different request with 422 idempotency.key_reused_with_different_request.

Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/identity-invites/bulk-create" \
  -H "Idempotency-Key: 9f4e8c2a-1b3d-4f5e-8a7c-2d1e3b4c5d6e" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "invites": [
      {
        "client_id": "string",
        "intent": "activate",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "role_id": "string",
        "node_id": "string",
        "send_email": true,
        "effective_from": "2026-04-20T12:00:00.000Z",
        "effective_to": "2026-04-20T12:00:00.000Z"
      }
    ]
  }'
Response
{
  "summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0
  },
  "results": [
    {
      "index": 0,
      "status": "success",
      "code": 0,
      "data": {
        "id": "string",
        "email": "string",
        "intent": "activate",
        "first_name": "string",
        "last_name": "string",
        "name": "string",
        "role_id": "string",
        "node_id": "string",
        "node_name": "string",
        "organization_node_id": "string",
        "effective_from": "2026-04-20T12:00:00.000Z",
        "effective_to": "2026-04-20T12:00:00.000Z",
        "has_initial_assignment": false,
        "status": "pending",
        "expires_at": "2026-04-20T12:00:00.000Z",
        "invited_by": "string",
        "invited_by_identity_id": "string",
        "created_at": "2026-04-20T12:00:00.000Z"
      }
    }
  ]
}
 Related endpoints
GETList invites
POSTCreate an invite
GETGet invite summary
POSTResend an invite
DELETERevoke an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy