Conduit calendar.event.edit

calendar.event.edit

API Method: calendar.event.edit

Summary

Apply transactions to create a new event or edit an existing one.

Returns

map<string, wild>

Errors

ERR-CONDUIT-CORE: See error message for details.

OAuth Scope

OAuth clients may never call this method.

Method Description

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.

Transaction Summary

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.

space

Shift the object between spaces.

Key	Type	Description
type	const	space
value	phid	New space PHID.

name

Rename the event.

Key	Type	Description
type	const	name
value	string	New event name.

isAllDay

Make the event an all day event.

Key	Type	Description
type	const	isAllDay
value	bool	Mark the event as an all day event.

start

Change the start time of the event.

Key	Type	Description
type	const	start
value	epoch	New event start time.

end

Change the end time of the event.

Key	Type	Description
type	const	end
value	epoch	New event end time.

cancelled

Cancel or restore the event.

Key	Type	Description
type	const	cancelled
value	bool	True to cancel the event.

hostPHID

Change the host of the event.

Key	Type	Description
type	const	hostPHID
value	phid	New event host.

inviteePHIDs

Change invited users.

Key	Type	Description
type	const	inviteePHIDs
value	list<phid>	New event invitees.

description

Update the event description.

Key	Type	Description
type	const	description
value	string	New event description.

icon

Change the event icon.

Key	Type	Description
type	const	icon
value	string	New event icon.

isRecurring

Make the event recurring.

Key	Type	Description
type	const	isRecurring
value	bool	Mark the event as a recurring event.

frequency

Change the event frequency.

Key	Type	Description
type	const	frequency
value	string	New event frequency.

until

Change when the event repeats until.

Key	Type	Description
type	const	until
value	epoch	New final event time.

view

Change the view policy of the object.

Key	Type	Description
type	const	view
value	string	New policy PHID or constant.

edit

Change the edit policy of the object.

Key	Type	Description
type	const	edit
value	string	New policy PHID or constant.

projects.add

Add project tags.

Key	Type	Description
type	const	projects.add
value	list<project>	List of PHIDs to add.

projects.remove

Remove project tags.

Key	Type	Description
type	const	projects.remove
value	list<project>	List of PHIDs to remove.

projects.set

Set project tags, overwriting current value.

Key	Type	Description
type	const	projects.set
value	list<project>	List of PHIDs to set.

subscribers.add

Add subscribers.

Key	Type	Description
type	const	subscribers.add
value	list<user>	List of PHIDs to add.

subscribers.remove

Remove subscribers.

Key	Type	Description
type	const	subscribers.remove
value	list<user>	List of PHIDs to remove.

subscribers.set

Set subscribers, overwriting current value.

Key	Type	Description
type	const	subscribers.set
value	list<user>	List of PHIDs to set.

comment

Make comments.

Key	Type	Description
type	const	comment
value	string	Comment to add, formatted as remarkup.

mfa

Sign this transaction group with MFA.

Key	Type	Description
type	const	mfa
value	bool

Call Method

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://scm.opengress.net/ --conduit-token <conduit-token> -- calendar.event.edit