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 macro.edit
macro.edit
macro.edit
API Method: macro.edit
API Method: macro.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 | Name of the macro. |
| filePHID | File PHID to import. |
| 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: name
Transaction Type: name
Name of the macro.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New macro name. |
Transaction Type: filePHID
Transaction Type: filePHID
File PHID to import.
| Key | Type | Description |
|---|---|---|
| type | const | filePHID |
| value | phid | File PHID. |
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://phab.hepforge.org/ --conduit-token <conduit-token> -- macro.edit
$ curl https://phab.hepforge.org/api/macro.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://phab.hepforge.org/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('macro.edit', $api_parameters);
print_r($result);