Invite someone by email
POST/v1/team/invites
The link works for 24 hours and once.
Body
| Field | Type | Description |
|---|---|---|
| emailrequired | string | |
| rolerequired | Role | A console role. Each bounds the scopes its holder can grant to a key. One of owner, admin, developer, billing, support, analyst, auditor. |
Example
curl -X POST https://api.woyra.io/v1/team/invites \
-H "Authorization: Bearer $WOYRA_KEY" \
-H 'Content-Type: application/json' \
-d '{
"email": "alex@example.com",
"role": "owner"
}'Response
201 The pending invitation.
| Field | Type | Description |
|---|---|---|
| object | "invite" | |
| id | string | |
| string | ||
| role | Role | A console role. Each bounds the scopes its holder can grant to a key. One of owner, admin, developer, billing, support, analyst, auditor. |
| invited_by | string | The inviting user's ID. |
| expires_at | timestamp |
Errors
| Status | Codes |
|---|---|
| 400 | invalid_request, unsupported_version |
| 403 | insufficient_scope, domain_not_verified, recipient_suppressed, sending_paused, mfa_required |
Also in Team
- GET /v1/team/members — List the team
- PATCH /v1/team/members/{id} — Change a member's role
- DELETE /v1/team/members/{id} — Remove a member
- GET /v1/team/invites — List pending invitations
- DELETE /v1/team/invites/{id} — Cancel an invitation