Cancel a guest's registration to a class

Purpose: The purpose of this API is to cancel the registration of a user to a class.

You must provide a unique identifier for the class_id as well as for the registration_id. The API then cancels the registration of a user to the class.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

error Object

MessageCodeDescription
Something went wrong. Message: The invoice for the registration is closed. Please reopen the invoice and try again.1035This error message appears when you are trying to cancel the guest's registration on a class for which the invoice is already closed.
Invalid registration1004This message appears when the registration_id is invalid.
Class not found1001This message appears when the class_id is invalid.
Passed class is not associated with passed registratio1004This message appears when the class_id and the registration_id are not associated with each other.
Path Params
int32
required

Unique identifier of the class.

int32
required

Unique identifier of the registration of the class session booking that is to be canceled.

Body Params
boolean

As per your business policy, you can waive the cancelation fee. True: The cancellation fee is waived. False. The cancellation fee is not waived.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json