Invite an identity into a location with a role
/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/invitationsAuthentication
Bearer Token
AuthorizationJWT access token. Never send alongside X-API-Key: a request carrying both is refused.
Request body
application/json
emailstring Required firstNamestring Optional lastNamestring Optional nodeIdstring Required roleIdstring Required Responses
application/json
data *WorkspaceInvitationResponseDto
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
application/json
error *ApiErrorBodyDto
Returned object
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/invitations" \ -H "Authorization: Bearer $CANOPY_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "firstName": "string", "lastName": "string", "nodeId": "string", "roleId": "string" }'
{ "data": { "id": "string", "email": "string", "first_name": "string", "last_name": "string", "name": "string", "role_id": "string", "role_name": "string", "node_id": "string", "node_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" } }
Tell us how we can improve this guide.