Skip to content
AveraAveraAvera Documentation

Invite an external collaborator into a tenant

POST
/api/v1/tenants/{tenantId}/participations/invitations
curl --request POST \
  --url https://app.avera.io/api/v1/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/participations/invitations \
  --header 'Content-Type: application/json' \
  --data '{ "inviteeEmail": "example", "inviteeDisplayName": "example", "scope": "INTERNAL", "endDate": "2026-04-15T12:00:00Z", "agreementRef": "example", "invitationReason": "example", "initialPassword": "example" }'

Creates a pending participation the invitee accepts or declines from their own account. Avera sends no invitation email: the administrator hands over the initial password out of band. Tenant-admin gated.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
inviteeEmail
required
string
inviteeDisplayName
required
string
scope
required
string
Allowed values: INTERNAL EXTERNAL SUPPORT
endDate
string | null format: date-time
agreementRef
string | null
invitationReason
required
string
initialPassword
string | null

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string format: uuid
tenantId
required
string format: uuid
tenantName
string | null
tenantSlug
string | null
userId
required
string format: uuid
scope
required
string
Allowed values: INTERNAL EXTERNAL SUPPORT
roles
required
Array<string>
Allowed values: TENANT_OWNER TENANT_ADMIN USER_ADMIN MEMBER
publicDisplayName
required
string
status
required
string
Allowed values: PENDING_ACCEPTANCE ACTIVE SUSPENDED ENDED
startDate
required
string format: date-time
endDate
string | null format: date-time
acceptedAt
string | null format: date-time
invitationReason
string | null
agreementRef
string | null
createdAt
required
string format: date-time