Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Add Participant

Developer Preview

Adds a participant to a schedule or to a specific session.

Permissions
This endpoint requires the Manage Bookings permissions scope

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

POST

https://www.wixapis.com/bookings/v1/calendar/participants

Body Params

NAME
TYPE
DESCRIPTION
scheduleId
Required

string

Schedule ID. Required.

sessionId

string

Optional. If this field is given, the participant will be added to this specific session.

participant

object

Participant.

Response Object

NAME
TYPE
DESCRIPTION
participant

object

Participant.

scheduleId

string

Schedule ID.

sessionId

string

Session ID. Optional.

schedule

object

Schedule.

session

object

Session.

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Add participant to schedule.

Adds a participant to a schedule.

Request

curl

Copy Code
1curl -X POST \
2 'https://www.wixapis.com/bookings/v1/calendar/participants' \
3 -H "Content-Type: application/json" \
4 -H 'Authorization: <AUTH>' \
5 --data '{
6 "participant": { "id":"8be22fc4-036a-4998-97ce-91a5dae2bd17",
7 "name": "John Charles",
8 "email": "john.charles@wix.com",
9 "partySize": 1,
10 "phone": "212-658-4492"
11 },
12 "scheduleId": "ef17e614-f318-41f4-9fc4-e6baa562f7e7"
13 }'

Response

json

1
2{
3 "scheduleId": "ef17e614-f318-41f4-9fc4-e6baa562f7e7",
4 "participant": {
5 "id": "8be22fc4-036a-4998-97ce-91a5dae2bd17",
6 "name": "John Charles",
7 "phone": "212-658-4492",
8 "email": "john.charles@wix.com",
9 "partySize": 1,
10 "approvalStatus": "UNDEFINED"
11 },
12 "schedule": {
13 "id": "ef17e614-f318-41f4-9fc4-e6baa562f7e7",
14 "scheduleOwnerId": "3d7dba43-d214-4149-8a53-a1a4a0c1e636",
15 "firstSessionStart": "2020-04-30T14:00:00Z",
16 "lastSessionEnd": "2021-04-29T17:00:00Z",
17 "timeZone": "America/Denver",
18 "intervals": [ {
19 "id": "4b8d0a0e-6e4e-4557-8377-f1209f759eb3",
20 "start": "2020-04-28T21:00:00Z",
21 "end": "2021-04-29T20:59:59.999Z",
22 "interval": {
23 "daysOfWeek": "THU",
24 "hourOfDay": 10,
25 "minuteOfHour": 0,
26 "duration": 180
27 },
28 "frequency": {"repetition": 1},
29 "affectedSchedules": [ {
30 "scheduleId": "e07c6328-4495-4b80-b04d-c45f13215881",
31 "transparency": "BUSY",
32 "scheduleOwnerId": "76570209-101f-409b-af97-b445bdb63125"
33 }]
34 }],
35 "title": "Intermediate Ski Class",
36 "tags": ["GROUP"],
37 "location": {"locationType": "OWNER_BUSINESS"},
38 "capacity": 50,
39 "rate": {"labeledPriceOptions": {"general": {
40 "amount": "180",
41 "currency": "USD",
42 "downPayAmount": "0"
43 }}},
44 "totalNumberOfParticipants": 0,
45 "participants": [],
46 "status": "CREATED",
47 "created": "2020-04-29T19:24:21.830Z",
48 "updated": "2020-04-29T19:24:21.830Z",
49 "version": 0,
50 "inheritedFields": ["timeZone"]
51 }
52}
Add participant to session