Page MenuHomeTOPSO Code
Conduit phame.post.edit

phame.post.edit

API Method: phame.post.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.

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
blogChoose a blog to create a post on (or move a post to).
titleRetitle the post.
subtitleChange the post subtitle.
visibilityChange post visibility.
bodyChange post body.
interactChange the interaction policy of the object.
projects.addAdd project tags.
projects.removeRemove project tags.
projects.setSet project tags, overwriting current value.
subscribers.addAdd subscribers.
subscribers.removeRemove subscribers.
subscribers.setSet subscribers, overwriting current value.
commentMake comments.
mfaSign this transaction group with MFA.

blog

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

KeyTypeDescription
typeconstblog
valuephidPHID of the blog.

title

Retitle the post.

KeyTypeDescription
typeconsttitle
valuestringNew post title.

subtitle

Change the post subtitle.

KeyTypeDescription
typeconstsubtitle
valuestringNew post subtitle.

visibility

Change post visibility.

KeyTypeDescription
typeconstvisibility
valuestringNew post visibility constant.

body

Change post body.

KeyTypeDescription
typeconstbody
valuestringNew post body.

interact

Change the interaction policy of the object.

KeyTypeDescription
typeconstinteract
valuestringNew policy PHID or constant.

projects.add

Add project tags.

KeyTypeDescription
typeconstprojects.add
valuelist<project>List of PHIDs to add.

projects.remove

Remove project tags.

KeyTypeDescription
typeconstprojects.remove
valuelist<project>List of PHIDs to remove.

projects.set

Set project tags, overwriting current value.

KeyTypeDescription
typeconstprojects.set
valuelist<project>List of PHIDs to set.

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://code.topso.ru/ --conduit-token <conduit-token> -- phame.post.edit