Skip to main content
POST
/
mailbox-schedule
/
Create Mailbox Health Schedule
curl --request POST \
  --url https://api-v2.missioninbox.com/mailbox-schedule/ \
  --header 'Content-Type: application/json' \
  --data '{
  "frequency": "weekly",
  "day_of_week": 0,
  "time": "<string>",
  "status": "active"
}'
{
  "id": 123,
  "user": 123,
  "frequency": "weekly",
  "day_of_week": 0,
  "time": "<string>",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "last_run": "2023-11-07T05:31:56Z",
  "next_run": "2023-11-07T05:31:56Z"
}

Body

Serializer for MailboxHealthSchedule model

frequency
enum<string>
  • weekly - Weekly
  • biweekly - Every other week
  • monthly - Monthly
Available options:
weekly,
biweekly,
monthly
day_of_week
enum<integer>
  • 0 - Sunday
  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Saturday
Available options:
0,
1,
2,
3,
4,
5,
6
time
string<time>

Time of day to run the health check (24-hour format)

status
enum<string>
  • active - Active
  • inactive - Inactive
Available options:
active,
inactive

Response

201 - application/json

Serializer for MailboxHealthSchedule model

id
integer
required
user
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
last_run
string<date-time> | null
required
next_run
string<date-time> | null
required
frequency
enum<string>
  • weekly - Weekly
  • biweekly - Every other week
  • monthly - Monthly
Available options:
weekly,
biweekly,
monthly
day_of_week
enum<integer>
  • 0 - Sunday
  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Saturday
Available options:
0,
1,
2,
3,
4,
5,
6
time
string<time>

Time of day to run the health check (24-hour format)

status
enum<string>
  • active - Active
  • inactive - Inactive
Available options:
active,
inactive