Create Invite Code

POST

/api/superadmin/invite-codes

curl --request POST \
  --url https://example.com/api/superadmin/invite-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example", "description": "example", "max_uses": 1, "expires_at": "example", "org_id": "example", "role": "member" }'

Create a new invite code.

Authorizations

• HTTPBearer

Request Body ^required

Media type application/json

CreateInviteCodeRequest

object

code

required

Code

string

description

Any of:

string

string

null

null

max_uses

Any of:

integer

integer

null

null

expires_at

Any of:

string

string

null

null

org_id

Any of:

string

string

null

null

role

Role

string

default: member

Responses

201

Successful Response

Media type application/json

InviteCodeResponse

object

id

required

Id

string

code

required

Code

string

description

Any of:

string

string

null

null

created_by

required

Created By

string

max_uses

Any of:

integer

integer

null

null

uses_count

required

Uses Count

integer

expires_at

Any of:

string

string

null

null

org_id

Any of:

string

string

null

null

role

required

Role

string

is_active

required

Is Active

boolean

created_at

Any of:

string

string

null

null

Example ^generated

{
  "id": "example",
  "code": "example",
  "description": "example",
  "created_by": "example",
  "max_uses": 1,
  "uses_count": 1,
  "expires_at": "example",
  "org_id": "example",
  "role": "example",
  "is_active": true,
  "created_at": "example"
}

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": {}
    }
  ]
}