PATCH /api/v1/classrooms/slots/{classroomSlotId}/rsvp
Update the RSVP Status of users who are already registered to a given slot by submitting their userID and their new status.
Variables
Path variables
Name | Type | Example | Description |
---|
classroomSlotId | ObjectId as string | 1a2b3c4d5e6f7a8b9c8d7e6f | The ID of the classroomSlot |
Responses
Success
message: "X user(s) updated"
Errors
Status code | Error body | Reason |
---|
401 | { "error": "{{usual_route_authentication_errors}}" } | Bad authentication (missing/unmatching/unexisting authentication) |
404 | { "error": "classroomSlot_not_found" } | classroomSlot specified does not belong to the company |
400 | { "error": "user_not_found" } | User doesn't belong to the company |
400 | { "error": "BadRequest" } | The user has an invalid request body |
Servers
- https://app.360learning.com
Path parameters
Name |
Type |
Required |
Description |
classroomSlotId |
String |
Yes |
The ID of the classroom slot
|
Request headers
Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/json"
|
Query parameters
Name |
Type |
Required |
Description |
company |
String |
No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods.
|
apiKey |
String |
No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods.
|
Request body fields
Name |
Type |
Required |
Description |
users[] |
Array |
No |
|
users[].userId |
String |
No |
|
users[].RSVPStatus |
Boolean |
No |
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.