Edit an alarm
Edit the configuration of an alarm.
Request URL
POST {base_url}/{api_path}/wakeupcall/update?access_token={access_token}
Request parameters
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | Integer | The unique ID of an alarm. Note: You can
query alarm's ID using Query Alarm List. |
alarm_time | No | String | The alarm time in 24-hour clock format. For example:
07:30 . |
repeat_type | No | String | How often will the alarm be repeated. Valid value:
Note:
|
number_of_snoozes | No | Integer | How many times will the alarm be repeated. Valid
value:
|
snooze_duration | No | Integer | The interval in minutes between each repeat. |
alarm_prompt | No | String | The name of alarm prompt. Note:
|
Response parameters
Parameter | Type | Description |
---|---|---|
errcode | Integer | Returned error code.
Note: You can check the error code and
error message in Error Code and Error Message.
|
errmsg | String | Returned message.
|
Examples
Request example
Change alarm time to 07:00 (ID: "14").
POST /openapi/v1.0/wakeupcall/update?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
"id":14,
"alarm_time":"07:00"
}
Response example
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS"
}