Deactivate invite code

DELETE

/api/v1/beta/codes/{code_id}

curl --request DELETE \
  --url https://api.ultimateteam.ai/api/v1/beta/codes/example \
  --header 'X-API-Key: <X-API-Key>'

• Production
• Local development

Deactivate an invite code so it can no longer be redeemed. Admin only.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

code_id

required

Code Id

string

Responses

200

Successful Response

Media typeapplication/json

DeactivateResponse

Response body after deactivating an invite code.

Attributes: deactivated: Whether the code was deactivated. code_id: The UUID of the deactivated code.

object

code_id

required

Code Id

string

deactivated

required

Deactivated

boolean

Example^generated

{
  "code_id": "example",
  "deactivated": true
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}