Conduit project.edit

project.edit

API Method: project.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
parent	Choose a parent project to create a subproject beneath.
milestone	Choose a parent project to create a new milestone for.
space	Shift the object between spaces.
name	Rename the project
description	Short project description.
icon	Change the project icon.
color	Change the project tag color.
slugs	Change project slugs.
members.add	Add members.
members.remove	Remove members.
members.set	Set members, overwriting the current value.
view	Change the view policy of the object.
edit	Change the edit policy of the object.
join	Change the join policy of the object.
subtype	Change the object subtype.
mfa	Sign this transaction group with MFA.

Transaction Type: parent

Choose a parent project to create a subproject beneath.

Key	Type	Description
type	const	parent
value	phid	PHID of the parent project.

Transaction Type: milestone

Choose a parent project to create a new milestone for.

Key	Type	Description
type	const	milestone
value	phid	PHID of the parent project.

Transaction Type: space

Shift the object between spaces.

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

Transaction Type: name

Rename the project

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

Transaction Type: description

Short project description.

Key	Type	Description
type	const	description
value	string

Transaction Type: icon

Change the project icon.

Key	Type	Description
type	const	icon
value	string	New project icon.

Transaction Type: color

Change the project tag color.

Key	Type	Description
type	const	color
value	string	New project tag color.

Transaction Type: slugs

Change project slugs.

Key	Type	Description
type	const	slugs
value	list<string>	New list of slugs.

Transaction Type: members.add

Add members.

Key	Type	Description
type	const	members.add
value	list<user>	List of PHIDs to add.

Transaction Type: members.remove

Remove members.

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

Transaction Type: members.set

Set members, overwriting the current value.

Key	Type	Description
type	const	members.set
value	list<user>	List of PHIDs to set.

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: join

Change the join policy of the object.

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

Transaction Type: subtype

Change the object subtype.

Key	Type	Description
type	const	subtype
value	string	New object subtype key.

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://forge.softwareheritage.org/ --conduit-token <conduit-token> -- project.edit