Skip to content
em sa em sa

Bulk Invite

POST
/api/orgs/{org_id}/admin/invite
 
curl --request POST \
  --url https://example.com/api/orgs/example/admin/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "emails": [ "example" ], "role": "member" }'

Bulk invite users to the org by email (admin/owner only).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
Org Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
BulkInviteRequest
object
emails
required
Emails
Array<string>
role
Role
string
default: member

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
BulkInviteResponse
object
invited
required
Invited
integer
already_members
required
Already Members
integer
pending_invites
Pending Invites
integer
0
failed
required
Failed
Array<string>
failed_reasons
Failed Reasons
object
key
additional properties
string
Example 
{
  "pending_invites": 0,
  "failed_reasons": {}
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}