1. Docs
  2. API Reference
  3. Invite a member into an organization

Invite a member into an organization

POST/api/v1/organizations/{id}/invites

Invites an email into the organization with the role bound to the invitation; acceptance creates the Environment membership and the organization membership in one step. Works for emails with no identity in the Environment — one is created on acceptance. Requires the identity.manage permission and emits invite.created.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Request body

application/json

emailstring Required

Email to invite. Works for people with no identity in this Environment — one is created when they accept.

role_idstring Required

The role the member will hold in this organization on acceptance.

first_namestring Optional
last_namestring Optional
send_emailboolean Optional

Set false to skip the email and deliver the returned accept URL yourself.

Responses

application/json

  • dataApiIdentityInviteResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

ApiIdentityInviteResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/organizations/value/invites" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "role_id": "string",
    "first_name": "string",
    "last_name": "string",
    "send_email": true
  }'
Response
{
  "data": {
    "id": "string",
    "email": "string",
    "intent": "activate",
    "first_name": "string",
    "last_name": "string",
    "name": "string",
    "role_id": "string",
    "node_id": "string",
    "environment_id": "string",
    "environment_name": "string",
    "has_initial_assignment": false,
    "status": "pending",
    "expires_at": "2026-04-20T12:00:00.000Z",
    "invited_by": "string",
    "created_at": "2026-04-20T12:00:00.000Z",
    "accept_url": "string"
  }
}
 Related endpoints
GETList organizations
POSTCreate an organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
DELETERevoke an organization invitation
 Was this page helpful?

Tell us how we can improve this guide.

Canopy