Skip to content
UltimateTeam.ai Docs

Update a waitlist entry

PATCH
/api/v1/waitlist/{entry_id}
curl --request PATCH \
  --url https://api.ultimateteam.ai/api/v1/waitlist/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "notes": "example", "status": "example" }'

Update status or notes on a waitlist entry. Admin authentication required.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
entry_id
required
Entry Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WaitlistUpdateRequest

Request body for updating a waitlist entry.

Attributes: status: New lifecycle status. notes: New admin notes (optional).

object
notes
Any of:
string
status
Any of:
string
<= 50 characters
Examplegenerated
{
  "notes": "example",
  "status": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Update Waitlist Entry Api V1 Waitlist Entry Id Patch
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}