WoyraDocs
Get an API key

Invite someone by email

POST/v1/team/invites

Team · Requires an API key

The link works for 24 hours and once.

Body

FieldTypeDescription
emailrequiredstring
rolerequiredRoleA 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.

FieldTypeDescription
object"invite"
idstring
emailstring
roleRoleA console role. Each bounds the scopes its holder can grant to a key.
One of owner, admin, developer, billing, support, analyst, auditor.
invited_bystringThe inviting user's ID.
expires_attimestamp

Errors

StatusCodes
400invalid_request, unsupported_version
403insufficient_scope, domain_not_verified, recipient_suppressed, sending_paused, mfa_required

Also in Team