Conduit phame.post.edit

phame.post.edit

API Method: phame.post.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
blog	Choose a blog to create a post on (or move a post to).
title	Retitle the post.
subtitle	Change the post subtitle.
visibility	Change post visibility.
body	Change post body.
interact	Change the interaction policy of the object.
projects.add	Add project tags.
projects.remove	Remove project tags.
projects.set	Set project tags, overwriting current value.
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.

blog

Choose a blog to create a post on (or move a post to).

Key	Type	Description
type	const	blog
value	phid	PHID of the blog.

title

Retitle the post.

Key	Type	Description
type	const	title
value	string	New post title.

subtitle

Change the post subtitle.

Key	Type	Description
type	const	subtitle
value	string	New post subtitle.

visibility

Change post visibility.

Key	Type	Description
type	const	visibility
value	string	New post visibility constant.

body

Change post body.

Key	Type	Description
type	const	body
value	string	New post body.

interact

Change the interaction policy of the object.

Key	Type	Description
type	const	interact
value	string	New policy PHID or constant.

projects.add

Add project tags.

Key	Type	Description
type	const	projects.add
value	list<project>	List of PHIDs to add.

projects.remove

Remove project tags.

Key	Type	Description
type	const	projects.remove
value	list<project>	List of PHIDs to remove.

projects.set

Set project tags, overwriting current value.

Key	Type	Description
type	const	projects.set
value	list<project>	List of PHIDs to set.

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://phab.antipode.net/ --conduit-token <conduit-token> -- phame.post.edit