Conduit phurls.edit

phurls.edit

API Method: phurls.edit

Returns

map<string, wild>

Errors

ERR-CONDUIT-CORE: See error message for details.

OAuth Scope

OAuth clients may never call this 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 Types

This endpoint supports these types of transactions. See below for detailed information about each transaction type.

Key	Description
space	Shift the object between spaces.
name	URL name.
url	The URL to shorten.
alias	The alias to give the URL.
description	URL long description.
view	Change the view policy of the object.
edit	Change the edit 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.

Transaction Type: space

Shift the object between spaces.

Key	Type	Description
type	const	space
value	phid	New space PHID.

Transaction Type: name

URL name.

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

Transaction Type: url

The URL to shorten.

Key	Type	Description
type	const	url
value	string	New URL.

Transaction Type: alias

The alias to give the URL.

Key	Type	Description
type	const	alias
value	string	New alias.

Transaction Type: description

URL long description.

Key	Type	Description
type	const	description
value	string	New URL description.

Transaction Type: view

Change the view policy of the object.

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

Transaction Type: edit

Change the edit policy of the object.

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

Transaction Type: projects.add

Add project tags.

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

Transaction Type: projects.remove

Remove project tags.

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

Transaction Type: projects.set

Set project tags, overwriting current value.

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

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

Remove subscribers.

Key	Type	Description
type	const	subscribers.remove
value	list<user>	List of PHIDs to remove.

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

Make comments.

Key	Type	Description
type	const	comment
value	string	Comment to add, formatted as remarkup.

Transaction Type: 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://collaboration.hexavara.com/ --conduit-token <conduit-token> phurls.edit