Platform APIEnterprise
Update a timer task
Update a timer task's schedule, category, retry policy, or callback configuration.
HTTP request
POST {API_ADDRESS}/timer/update_timer_taskRequest example
curl --request POST "${API_ADDRESS}/timer/update_timer_task" --header "Content-Type: application/json" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" --data-raw '{"taskID":"task_001","taskName":"Updated reminder","executeAt":1719900000000,"userID":"user_001"}'Request body
| Parameter | Required | Type | Description |
|---|---|---|---|
| taskID | Yes | string | Timer task ID. |
| userID | Yes | string | User associated with the task. |
| taskName | No | string | New name. |
| taskCategory | No | string | New business category. |
| executeAt | No | int | New execution time in Unix milliseconds. |
| executeBefore | No | int | New latest execution time in Unix milliseconds. |
| maxRetry | No | int | New maximum retry count. |
| callbackConfig | No | TimerTaskCallbackConfig | New callback configuration. |
Response
The common response has errCode: 0 when the task was updated successfully.
Errors
See Error codes.
Permissions and limits
- Available only in OpenIM Enterprise.
- Omit fields that should remain unchanged.
Related pages
Was this page helpful?