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 conpherence.edit
conpherence.edit
conpherence.edit
API Method: conpherence.edit
API Method: conpherence.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 |
|---|---|
| name | Room name. |
| topic | Room topic. |
| participants.add | Room participants. |
| participants.remove | Room participants. |
| participants.set | Room participants. |
| view | Change the view policy of the object. |
| edit | Change the edit policy of the object. |
| comment | Make comments. |
| mfa | Sign this transaction group with MFA. |
Transaction Type: name
Transaction Type: name
Room name.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New Room name. |
Transaction Type: topic
Transaction Type: topic
Room topic.
| Key | Type | Description |
|---|---|---|
| type | const | topic |
| value | string | New Room topic. |
Transaction Type: participants.add
Transaction Type: participants.add
Room participants.
| Key | Type | Description |
|---|---|---|
| type | const | participants.add |
| value | list<user> | List of PHIDs to add. |
Transaction Type: participants.remove
Transaction Type: participants.remove
Room participants.
| Key | Type | Description |
|---|---|---|
| type | const | participants.remove |
| value | list<user> | List of PHIDs to remove. |
Transaction Type: participants.set
Transaction Type: participants.set
Room participants.
| Key | Type | Description |
|---|---|---|
| type | const | participants.set |
| value | list<user> | List of PHIDs to set. |
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: 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://collaboration.hexavara.com/ --conduit-token <conduit-token> conpherence.edit
$ curl https://collaboration.hexavara.com/api/conpherence.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://collaboration.hexavara.com/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('conpherence.edit', $api_parameters);
print_r($result);