Invitations

Base path: https://gateway.useyona.com/a/v1

Invite team members to your organization. Invitations include a role assignment and optional custom permissions. Invitees receive an email with a code to accept and create their account.

Invite user

POST /a/v1/organizations/:orgId/invitations

Send an invitation to join the organization.

Request body

Field	Type	Required	Description
`email`	string	Yes	Email to invite
`fullName`	string	Yes	Invitee’s full name, 2-255 chars
`roleId`	string	No	Role UUID to assign
`customPermissions`	string[]	No	Array of permission strings
`message`	string	No	Personal message, max 500 chars

bash

curl -X POST https://gateway.useyona.com/a/v1/organizations/9f8e7d6c-5b4a-3210-fedc-ba9876543210/invitations \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "colleague@zenithsoftware.ng",
    "fullName": "Amara Obi",
    "roleId": "role_member",
    "message": "Welcome to the team!"
  }'

Accept invitation (public)

POST /a/v1/accept-invitation

Accept an invitation and create an account. No authentication required.

Request body

Field	Type	Required	Description
`invitationCode`	string	Yes	Invitation code from email
`email`	string	Yes	Email the invitation was sent to
`password`	string	Yes	Account password (8-50 chars)
`firstName`	string	No	First name
`lastName`	string	No	Last name

bash

curl -X POST https://gateway.useyona.com/a/v1/accept-invitation \
  -H "Content-Type: application/json" \
  -d '{
    "invitationCode": "inv_a1b2c3d4e5f6",
    "email": "colleague@zenithsoftware.ng",
    "password": "SecurePass123!",
    "firstName": "Amara",
    "lastName": "Obi"
  }'

Other invitation endpoints

Method	Path	Description
`GET`	`/a/v1/organizations/:orgId/invitations`	List invitations
`POST`	`/a/v1/organizations/:orgId/invitations/:id/resend`	Resend invitation
`DELETE`	`/a/v1/organizations/:orgId/invitations/:id`	Revoke invitation
`POST`	`/a/v1/verify-invitation`	Verify invitation code (public)