Conduit macro.edit

macro.edit

API Method: macro.edit

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
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.

name

Name of the macro.

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

filePHID

File PHID to import.

Key	Type	Description
type	const	filePHID
value	phid	File PHID.

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://vyos.dev/ --conduit-token <conduit-token> -- macro.edit