This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.
Conduit calendar.event.edit
calendar.event.edit
calendar.event.edit
API Method: calendar.event.edit
API Method: calendar.event.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- Returns
- map<string, wild>
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Description
Transaction Types
Transaction Types
This endpoint supports these types of transactions. See below for detailed information about each transaction type.
| Key | Description |
|---|---|
| space | Shift the object between spaces. |
| name | Rename the event. |
| isAllDay | Make the event an all day event. |
| start | Change the start time of the event. |
| end | Change the end time of the event. |
| cancelled | Cancel or restore the event. |
| hostPHID | Change the host of the event. |
| inviteePHIDs | Change invited users. |
| description | Update the event description. |
| icon | Change the event icon. |
| isRecurring | Make the event recurring. |
| frequency | Change the event frequency. |
| until | Change when the event repeats until. |
| view | Change the view policy of the object. |
| edit | Change the edit policy of the object. |
| projects.add | Add project tags. |
| projects.remove | Remove project tags. |
| projects.set | Set project tags, overwriting current value. |
| subscribers.add | Add subscribers. |
| subscribers.remove | Remove subscribers. |
| subscribers.set | Set subscribers, overwriting current value. |
| comment | Make comments. |
| mfa | Sign this transaction group with MFA. |
Transaction Type: space
Transaction Type: space
Shift the object between spaces.
| Key | Type | Description |
|---|---|---|
| type | const | space |
| value | phid | New space PHID. |
Transaction Type: name
Transaction Type: name
Rename the event.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New event name. |
Transaction Type: isAllDay
Transaction Type: isAllDay
Make the event an all day event.
| Key | Type | Description |
|---|---|---|
| type | const | isAllDay |
| value | bool | Mark the event as an all day event. |
Transaction Type: start
Transaction Type: start
Change the start time of the event.
| Key | Type | Description |
|---|---|---|
| type | const | start |
| value | epoch | New event start time. |
Transaction Type: end
Transaction Type: end
Change the end time of the event.
| Key | Type | Description |
|---|---|---|
| type | const | end |
| value | epoch | New event end time. |
Transaction Type: cancelled
Transaction Type: cancelled
Cancel or restore the event.
| Key | Type | Description |
|---|---|---|
| type | const | cancelled |
| value | bool | True to cancel the event. |
Transaction Type: hostPHID
Transaction Type: hostPHID
Change the host of the event.
| Key | Type | Description |
|---|---|---|
| type | const | hostPHID |
| value | phid | New event host. |
Transaction Type: inviteePHIDs
Transaction Type: inviteePHIDs
Change invited users.
| Key | Type | Description |
|---|---|---|
| type | const | inviteePHIDs |
| value | list<phid> | New event invitees. |
Transaction Type: description
Transaction Type: description
Update the event description.
| Key | Type | Description |
|---|---|---|
| type | const | description |
| value | string | New event description. |
Transaction Type: icon
Transaction Type: icon
Change the event icon.
| Key | Type | Description |
|---|---|---|
| type | const | icon |
| value | string | New event icon. |
Transaction Type: isRecurring
Transaction Type: isRecurring
Make the event recurring.
| Key | Type | Description |
|---|---|---|
| type | const | isRecurring |
| value | bool | Mark the event as a recurring event. |
Transaction Type: frequency
Transaction Type: frequency
Change the event frequency.
| Key | Type | Description |
|---|---|---|
| type | const | frequency |
| value | string | New event frequency. |
Transaction Type: until
Transaction Type: until
Change when the event repeats until.
| Key | Type | Description |
|---|---|---|
| type | const | until |
| value | epoch | New final event time. |
Transaction Type: view
Transaction Type: view
Change the view policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | view |
| value | string | New policy PHID or constant. |
Transaction Type: edit
Transaction Type: edit
Change the edit policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | edit |
| value | string | New policy PHID or constant. |
Transaction Type: projects.add
Transaction Type: projects.add
Add project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.add |
| value | list<project> | List of PHIDs to add. |
Transaction Type: projects.remove
Transaction Type: projects.remove
Remove project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.remove |
| value | list<project> | List of PHIDs to remove. |
Transaction Type: projects.set
Transaction Type: projects.set
Set project tags, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | projects.set |
| value | list<project> | List of PHIDs to set. |
Transaction Type: subscribers.add
Transaction Type: subscribers.add
Add subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.add |
| value | list<user> | List of PHIDs to add. |
Transaction Type: subscribers.remove
Transaction Type: subscribers.remove
Remove subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.remove |
| value | list<user> | List of PHIDs to remove. |
Transaction Type: subscribers.set
Transaction Type: subscribers.set
Set subscribers, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.set |
| value | list<user> | List of PHIDs to set. |
Transaction Type: comment
Transaction Type: comment
Make comments.
| Key | Type | Description |
|---|---|---|
| type | const | comment |
| value | string | Comment to add, formatted as remarkup. |
Transaction Type: mfa
Transaction Type: mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool |
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://arendus.eenet.ee/ --conduit-token <conduit-token> calendar.event.edit
$ curl https://arendus.eenet.ee/api/calendar.event.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/libphutil/src/__phutil_library_init__.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://arendus.eenet.ee/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('calendar.event.edit', $api_parameters);
print_r($result);