/api/v1/team/invites (POST)

POST

/api/v1/team/invites

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

Authorizations

• Bearer

Request Body^required

object

email

required

string

roleIds

required

Array<string>

expiresInDays

integer format: int32

default: 7

object

email

required

string

roleIds

required

Array<string>

expiresInDays

integer format: int32

default: 7

object

email

required

string

roleIds

required

Array<string>

expiresInDays

integer format: int32

default: 7

Responses

201

Created

object

id

required

string format: uuid

email

required

string

inviteUrl

required

string

expiresAt

required

string format: date-time

emailQueued

required

boolean

object

id

required

string format: uuid

email

required

string

inviteUrl

required

string

expiresAt

required

string format: date-time

emailQueued

required

boolean

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "example",
  "inviteUrl": "example",
  "expiresAt": "2026-04-15T12:00:00Z",
  "emailQueued": true
}

object

id

required

string format: uuid

email

required

string

inviteUrl

required

string

expiresAt

required

string format: date-time

emailQueued

required

boolean

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "example",
  "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"
}

409

Conflict

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"
}