Apis::V4::Challenges::Reminders API

creating a reminder

Parameters

Name Description
access_token JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
data[attributes][reminder_type] The type of reminder, can be one of: "once", "daily", "weekly", or "monthly"
data[attributes][reminder_at] The time the reminder should occur at, required for all types. For once, it should be an ISO 8601 date time string. For the remaining types, it should be an ISO 8601 time string ("hh:mm:ss") with no time zone qualification. Times for recurrences other than "once" are assumed to be in the users local time zone.
data[attributes][reminder_on] Meaning is contextual to the type of reminder. Only required for "weekly" and "monthly" reminders. For weekly it should be a string representing the day of the week ("monday", "saturday", etc.). For monthly reminders it should be an integer representing the day of the month (1 is the first, 15 is the 15th, -1 is the last day of the month).

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMjIsImV4cCI6MTcwNDQ3MzIzMCwiaWF0IjoxNzA0NDczMDUwfQ.TDKfl8U_q4qvKBLV1n5PVvYLi3X98-PURwtuFaW5bps
Host: example.org
Cookie: 

Route

PUT /apis/v4/challenges/62/reminder

Body

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMjIsImV4cCI6MTcwNDY0NTg1MCwiaWF0IjoxNzA0NDczMDUwfQ.dOECPyKDNGWWZRZY9Vyk14dUUQsioGDd0vYWyoEp8yE
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"54406e016b2b92f1d4ccd00e6593c591"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1388e33a-8cc5-45ed-8f6c-2fe8640bd9b8
X-Runtime: 0.018353
Content-Length: 282

Status

200

Body