application/json

Body

Request for creating a new Waiver

  • name string Required

    Name of the waiver

  • content string Required

    The content of the waiver

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      Prefixed ID for the Waiver

    • name string Required

      A title for the Waiver

    • content string Required

      The Waiver contents

    • type string Required

      Values are terms-and-conditions, privacy-policy, or custom.

    • isLocked boolean Required

      Whether the Waiver can be archived/deleted or have it's title changed

    • companyId string Required

      Company ID

    • archivedAt string(date-time) | null Required

      Archived at date

    • createdAt string(date-time) Required

      Created date

    • updatedAt string(date-time) Required

      Last updated date

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception

  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception

POST /v1/waivers/
curl \
 --request POST 'https://api.classmanager.io/v1/waivers/' \
 --header "Content-Type: application/json" \
 --data '{"name":"Refund waiver","content":"Potentially really long text with no HTML tags"}'
Request examples
{
  "name": "Refund waiver",
  "content": "Potentially really long text with no HTML tags"
}
Response examples (200)
{
  "id": "wvr_123123123123",
  "name": "Refund waiver",
  "content": "Potentially some really long content with no HTML tags",
  "type": "terms-and-conditions",
  "isLocked": true,
  "companyId": "co_123123123123",
  "archivedAt": "2024-06-12T09:39:49.000000Z",
  "createdAt": "2024-06-12T09:39:49.000000Z",
  "updatedAt": "2024-06-12T09:39:49.000000Z"
}
Response examples (403)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (422)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}