Skip to content
UltimateTeam.ai Docs

Change Member Status

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

Suspend (status=‘suspended’) or reactivate (status=‘active’).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
membership_id
required
Membership Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
StatusChangeRequest

PATCH /api/v1/members/{id} request body.

object
status
required
Status
string
Allowed values: active suspended

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
MemberRow

One row in GET /api/v1/members.

object
accepted_at
Any of:
string format: date-time
email
required
Email
string format: email
id
required
Id
string format: uuid
invited_at
required
Invited At
string format: date-time
last_active_at
Any of:
string format: date-time
role
required
Role
string
Allowed values: chairman operator viewer
status
required
Status
string
Allowed values: invited active suspended removed
Example
{
  "role": "chairman",
  "status": "invited"
}

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