Participants
Endpoints for working with the participants of a user.
Get participants
GET
/api/internal/v1/:partner_code/participants
Paginate all the participants of the currently logged-in user with the possiblitiy to search by first name, last name and email.
Path Parameters
partner_code
string
The partner code of the partner.
Request Body
page
integer
The number of the displayed page. Default is 1.
search
string
Search participants by first name, last name or email.
Get participant
GET
/api/internal/v1/:partner_code/participants/:participant_id
Get a participant by its id.
Path Parameters
partner_code
string
The partner code of the partner.
participant_id
integer
The id of the participant.
Create participant
POST
/api/internal/v1/:partner_code/participants
Create a new participant.
Path Parameters
partner_code
string
The partner code of the partner.
Request Body
first_name
string
The first name of the participant.
last_name
string
The last name of the participant.
gender
integer
The gender of the participant. Allowed values: 0,1,2
title
string
The title of the participant.
string
The email of the participant.
birthdate
string
The birthdate of the participant. Format: YYYY-MM-DD
Update participant
PUT
/api/internal/v1/:partner_code/participants/:participant_id
Update a participant by its id.
Path Parameters
partner_code
string
The partner code of the partner.
participant_id
integer
The id of the participant.
Request Body
first_name
string
The first name of the participant.
last_name
string
The last name of the participant.
gender
integer
The gender of the participant. Allowed values: 0,1,2
title
string
The title of the participant.
string
The email of the participant.
birthdate
string
The birthdate of the participant.
Delete participant
DELETE
/api/internal/v1/:partner_code/participants/:participant_id
Delete a participant by its id.
Path Parameters
partner_code
string
The partner code of the partner.
participant_id
integer
The id of the participant.
Last updated
Was this helpful?