Skip to content
Select themeSelect language

POST /organization/invites/bulk — invite many emails; per-email verdicts.

POST
/api/organization/invites/bulk
curl --request POST \
--url https://example.com/api/organization/invites/bulk \
--header 'Content-Type: application/json' \
--data '{ "emails": [ "example" ], "role": "example" }'
Media typeapplication/json
object
emails
required
Array<string>
role
string
Examplegenerated
{
"emails": [
"example"
],
"role": "example"
}
Media typeapplication/json

POST /organization/invites/bulk response.

object
results
required
Array<object>

One per-email verdict in the bulk-invite response. The success and failure branches carry DISJOINT keys — success emits invite_id (no error), failure emits error (no invite_id) — so both fields skip-when-None to preserve the exact per-branch wire shape (a key absent, never null).

object
email
required
string
error
string | null
invite_id
string | null format: uuid
ok
required
boolean
Examplegenerated
{
"results": [
{
"email": "example",
"error": "example",
"invite_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ok": true
}
]
}