/api/v1/team/invites/bulk

POST

/api/v1/team/invites/bulk

curl --request POST \
  --url https://example.com/api/v1/team/invites/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "invites": [ { "email": "example", "roleIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] } ], "expiresInDays": 7, "replaceExisting": false }'

Authorizations

• Bearer

Parameters

Query Parameters

dryRun

boolean

Request Body^required

object

invites

required

Array<object>

nullable

object

email

required

string

roleIds

required

Array<string>

expiresInDays

integer format: int32

default: 7

replaceExisting

boolean

object

invites

required

Array<object>

nullable

object

email

required

string

roleIds

required

Array<string>

expiresInDays

integer format: int32

default: 7

replaceExisting

boolean

object

invites

required

Array<object>

nullable

object

email

required

string

roleIds

required

Array<string>

expiresInDays

integer format: int32

default: 7

replaceExisting

boolean

Responses

200

OK

object

summary

required

object

requested

required

integer format: int32

created

required

integer format: int32

skipped

required

integer format: int32

emailQueued

required

integer format: int32

results

required

Array<object>

object

index

required

integer format: int32

email

required

string

status

required

string

inviteId

required

string format: uuid

nullable

inviteUrl

required

string

nullable

expiresAt

required

string format: date-time

nullable

emailQueued

required

boolean

nullable

object

summary

required

object

requested

required

integer format: int32

created

required

integer format: int32

skipped

required

integer format: int32

emailQueued

required

integer format: int32

results

required

Array<object>

object

index

required

integer format: int32

email

required

string

status

required

string

inviteId

required

string format: uuid

nullable

inviteUrl

required

string

nullable

expiresAt

required

string format: date-time

nullable

emailQueued

required

boolean

nullable

Example ^generated

{
  "summary": {
    "requested": 1,
    "created": 1,
    "skipped": 1,
    "emailQueued": 1
  },
  "results": [
    {
      "index": 1,
      "email": "example",
      "status": "example",
      "inviteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "inviteUrl": "example",
      "expiresAt": "2026-04-15T12:00:00Z",
      "emailQueued": true
    }
  ]
}

object

summary

required

object

requested

required

integer format: int32

created

required

integer format: int32

skipped

required

integer format: int32

emailQueued

required

integer format: int32

results

required

Array<object>

object

index

required

integer format: int32

email

required

string

status

required

string

inviteId

required

string format: uuid

nullable

inviteUrl

required

string

nullable

expiresAt

required

string format: date-time

nullable

emailQueued

required

boolean

nullable

Example ^generated

{
  "summary": {
    "requested": 1,
    "created": 1,
    "skipped": 1,
    "emailQueued": 1
  },
  "results": [
    {
      "index": 1,
      "email": "example",
      "status": "example",
      "inviteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "inviteUrl": "example",
      "expiresAt": "2026-04-15T12:00:00Z",
      "emailQueued": true
    }
  ]
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

errors

object

key

additional properties

Array<string>

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

errors

object

key

additional properties

Array<string>

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

errors

object

key

additional properties

Array<string>

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}