Skip to main content
POST
Invite User

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id
string<uuid>
required

The organization ID of the user's organization

Body

application/json
email
string<email>
required

The user's email address

role
enum<string>
default:user

The member role granted when the invitation is accepted. staff is a deprecated alias for support, normalised on the way in and removed in a future release; responses always carry support.

Available options:
admin,
support,
user,
guest
podero_profile
enum<string> | null

Designates the invitee a Podero user, granted the profile when the invitation is accepted. Only a Podero developer may send one.

Available options:
basic,
customer_ops,
developer

Response

OK

user_email
string
required
email_id
string<uuid>
required
invite_id
string<uuid>
required