API v1 ReferenceUsers
Invite user
Create a new user invitation with specified role and permissions. User will receive an invitation email to set up their account.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
first_name*string
User's first name
Length
1 <= lengthlast_name*string
User's last name
Length
1 <= lengthemail*string
User's email address
Format
emailrole*string
User's role in the system
Default
"viewer"Value in
"admin" | "account_manager" | "content_manager" | "viewer"Response Body
application/json
application/json
curl -X POST "https://app.orbiqhq.com/api/v1/users" \ -H "Content-Type: application/json" \ -d '{ "email": "admin@example.com", "first_name": "John", "last_name": "Admin", "role": "admin" }'{
"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?