Toggle Active status of a schedule

PUT 
/schedules/toggleStatus/:scheduleId

The Toggle active request allows you to toggle the isActive property of a schedule. This request takes in the schedule's unique ID as a parameter, and will toggle the isActive property of the schedule.

Request

Path Parameters

scheduleId stringrequired

The ID of the schedule to toggle the status

Responses

200

Schedule updated

application/json

Schema

Schema

_id uuid
name string

Possible values: >= 3 characters and <= 50 characters

startTime date-time
endTime date-time
type string

Possible values: [repeat, specific]

date date-time
isActive boolean
createdBy object
_id string
name string
email email
updatedBy object
_id string
name string
email email

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "startTime": "2024-12-03T13:26:27.737Z",
  "endTime": "2024-12-03T13:26:27.737Z",
  "type": "repeat",
  "date": "2024-12-03T13:26:27.737Z",
  "isActive": true,
  "createdBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  },
  "updatedBy": {
    "_id": "string",
    "name": "string",
    "email": "user@example.com"
  }
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...