TuCloudAPI updatecalendar
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.Description
Edit a calendar row (same fields and period rule as addcalendar). hold ABSENT keeps the stored value. With hold 0, expires_on is kept while the period (start and end) does not change, and computed again from today when it does or when the row goes from 1 to 0; hold 1 clears it. 404 if not in the caller's PBX. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=updatecalendar&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX. |
id |
integer | Yes | — | Calendar row id (_id). |
template |
integer | Yes | — | Calendar-template group 1-99. |
monthstart |
integer | Yes | — | Start month 1-12. |
monthend |
integer | Yes | — | End month 1-12. |
dayend |
integer | Yes | — | End day 1-31. |
destination |
integer | Yes | — | Route _id to divert to (required, in-tenant). |
daystart |
integer | No | 0 |
Start day 1-31, or 0/blank = all days (Todos). |
timestart |
string | No | 00:00 |
Start time HH:MM. |
timeend |
string | No | 00:00 |
End time HH:MM. |
hold |
integer | No | — | «Repetir cada año» 1/0; absent = keep the stored value. |
nota |
string | No | — | Free note (max 256). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=updatecalendar&ukey=KEY&pbx=tucall&id=81522&template=1&monthstart=1&daystart=1&monthend=1&dayend=1&destination=197
Response
{ok, calendar:{...}}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI