Skip to main content
POST
/
organizations
/
{organizationId}
/
members
/
invite
Invite user to organization
curl --request POST \
  --url https://api.hixbe.com/account/organizations/{organizationId}/members/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "roleName": "member",
  "message": "<string>"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "status": "PENDING",
  "roleName": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required

Body

application/json
​
email
string<email>
required

Email address of user to invite

​
roleName
string
default:member

Role to assign to the invited user

​
message
string

Optional invitation message

Maximum string length: 500

Response

201 - application/json

User invited successfully

​
id
string
required

Invitation unique identifier

​
email
string
required

Invited user's email

​
status
enum<string>
required

Invitation status

Available options:
PENDING,
ACCEPTED,
EXPIRED,
CANCELLED
​
roleName
string

Assigned role name

​
expiresAt
string<date-time>

Invitation expiration timestamp

​
createdAt
string<date-time>

Invitation creation timestamp