Invite user
Create a new user invitation with specified role and permissions. User will receive an invitation email to set up their account.
AuthorizationBearer <token>
In: header
first_namestring
User's first name
Length
1 <= lengthlast_namestring
User's last name
Length
1 <= lengthemailstring
User's email address
Format
emailrolestring
User's role in the system
Default
"viewer"Value in
"admin" | "account_manager" | "viewer"Response Body
const body = JSON.stringify({
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com",
"role": "account_manager"
})
fetch("https://app.orbiqhq.com/api/v1/users", {
body
}){
"success": true,
"data": {
"user": {
"id": "user-123",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com",
"role": {
"name": "Administrator"
},
"status": "active",
"title": "string",
"theme": "light",
"language": "en"
},
"createdUserId": "string"
}
}{
"error": "Invalid input: email: Invalid email address"
}Empty
Empty
Empty
How is this guide?