Page MenuHomeSCPF: Area-97
Conduit conpherence.edit

conpherence.edit

API Method: conpherence.edit

Login Required: This method requires authentication. You must log in before you can make calls to it.
Summary
Apply transactions to create a new room 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.

KeyDescription
nameRoom name.
topicRoom topic.
participants.addRoom participants.
participants.removeRoom participants.
participants.setRoom participants.
viewChange the view policy of the object.
editChange the edit policy of the object.
commentMake comments.
mfaSign this transaction group with MFA.

name

Room name.

KeyTypeDescription
typeconstname
valuestringNew Room name.

topic

Room topic.

KeyTypeDescription
typeconsttopic
valuestringNew Room topic.

participants.add

Room participants.

KeyTypeDescription
typeconstparticipants.add
valuelist<user>List of PHIDs to add.

participants.remove

Room participants.

KeyTypeDescription
typeconstparticipants.remove
valuelist<user>List of PHIDs to remove.

participants.set

Room participants.

KeyTypeDescription
typeconstparticipants.set
valuelist<user>List of PHIDs to set.

view

Change the view policy of the object.

KeyTypeDescription
typeconstview
valuestringNew policy PHID or constant.

edit

Change the edit policy of the object.

KeyTypeDescription
typeconstedit
valuestringNew policy PHID or constant.

comment

Make comments.

KeyTypeDescription
typeconstcomment
valuestringComment to add, formatted as remarkup.

mfa

Sign this transaction group with MFA.

KeyTypeDescription
typeconstmfa
valuebool

Call Method

Enter parameters using JSON. For instance, to enter a list, type: ["apple", "banana", "cherry"]

list<map<string, wild>>
optional id|phid|string

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://muchmo.net/ --conduit-token <conduit-token> -- conpherence.edit