Skip to main content
PUT
/
api
/
v1
/
participants
/
{id}
Update Participant
curl --request PUT \
  --url https://api.checkpoint.b-digital.uk/api/v1/participants/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "id": "<string>",
  "user_id": "<string>",
  "instance_id": "<string>",
  "first_name": "<string>",
  "surname": "<string>",
  "full_name": "<string>",
  "gender": "Male",
  "pronouns": "they/them",
  "status": "active",
  "date_of_birth": "2023-12-25",
  "school_year": "<string>",
  "rank": "<string>",
  "unit_name": "<string>",
  "school_institute": "<string>",
  "arrival_date": "2023-12-25",
  "departure_date": "2023-12-25",
  "super_group_id": "<string>",
  "sub_group_id": "<string>",
  "block_id": "<string>",
  "room_id": "<string>",
  "room_number": "<string>",
  "photo_link": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
'
{
  "success": true,
  "data": {},
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

id
string
required

Participant ID

Body

application/json
id
string
user_id
string
instance_id
string
first_name
string
surname
string
full_name
string
gender
enum<string>
Available options:
Male,
Female,
Other
pronouns
string

User's preferred pronouns (e.g., he/him, she/her, they/them)

Example:

"they/them"

status
enum<string>
Available options:
active,
inactive
date_of_birth
string<date>
school_year
string
rank
string
unit_name
string
school_institute
string
arrival_date
string<date>
departure_date
string<date>
super_group_id
string
sub_group_id
string
block_id
string
room_id
string
room_number
string
created_at
string<date-time>
updated_at
string<date-time>

Response

200 - application/json

Participant updated successfully

success
boolean
Example:

true

data
object
meta
object