Skip to main content
POST
/
admin
/
invitations
curl --request POST \
  --url https://asteragents.com/api/admin/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "invitations": [
    {
      "email": "user1@company.com"
    },
    {
      "email": "user2@company.com"
    }
  ]
}'
{
  "success": true,
  "total": 2,
  "successful": 2,
  "failed": 0,
  "results": [
    {
      "email": "newuser@company.com",
      "success": true,
      "invitationId": "orginv_2ABC123DEF",
      "status": "pending",
      "type": "invitation",
      "metadata": {}
    },
    {
      "email": "existinguser@company.com",
      "success": true,
      "userId": "user_2XYZ789GHI",
      "membershipId": "orgmem_2MNO456PQR",
      "status": "active",
      "type": "direct_membership",
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT token from Clerk authentication.

Must be from a user with org:admin role.

Body

application/json
​
invitations
object[]
required

Array of invitations to send

Required array length: 1 - 50 elements

Response

All invitations sent successfully

​
success
boolean
required
​
total
integer
required
​
successful
integer
required
​
failed
integer
required
​
results
object[]
required
  • Option 1
  • Option 2
​
errors
object[]