Page MenuHomeNEST
Conduit macro.edit

macro.edit

API Method: macro.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 macro 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
nameName of the macro.
filePHIDFile PHID to import.
subscribers.addAdd subscribers.
subscribers.removeRemove subscribers.
subscribers.setSet subscribers, overwriting current value.
commentMake comments.
mfaSign this transaction group with MFA.

name

Name of the macro.

KeyTypeDescription
typeconstname
valuestringNew macro name.

filePHID

File PHID to import.

KeyTypeDescription
typeconstfilePHID
valuephidFile PHID.

subscribers.add

Add subscribers.

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

subscribers.remove

Remove subscribers.

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

subscribers.set

Set subscribers, overwriting current value.

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

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://tasks.sustainnaperville.org/ --conduit-token <conduit-token> -- macro.edit