Create an invite
/portal/v1/accounts/{accountSlug}/user-invitesAuthentication
- Bearer Token
AuthorizationJWT access token
Request body
email *stringfirst_name *stringlast_name *string
Code samples
curl -X POST "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/user-invites" \
-H "Authorization: Bearer $CANOPY_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "string",
"first_name": "string",
"last_name": "string"
}'const response = await fetch("https://api.canopy.dev/portal/v1/accounts/{accountSlug}/user-invites", {
method: "POST",
headers: {
"Authorization": "Bearer $CANOPY_TOKEN",
"Content-Type": "application/json"
},
body: JSON.stringify({
"email": "string",
"first_name": "string",
"last_name": "string"
}),
});
const data = await response.json();import requests
response = requests.post(
"https://api.canopy.dev/portal/v1/accounts/{accountSlug}/user-invites",
headers={
"Authorization": "Bearer $CANOPY_TOKEN",
"Content-Type": "application/json"
},
json={
"email": "string",
"first_name": "string",
"last_name": "string",
},
)
data = response.json()package main
import (
"bytes"
"encoding/json"
"net/http"
)
func main() {
payload := map[string]interface{}{
"email": "string",
"first_name": "string",
"last_name": "string",
}
body, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/user-invites", 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
201 Invite created
{
"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"status": "pending",
"expires_at": "2026-04-20T12:00:00.000Z",
"invited_by": "string",
"created_at": "2026-04-20T12:00:00.000Z"
}application/json
id *stringemail *stringfirst_name *stringlast_name *stringname *stringstatus *enum: "pending" | "accepted" | "revoked" | "expired"expires_at *string (date-time)invited_by *stringcreated_at *string (date-time)
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)