Conduit project.edit

project.edit

API Method: project.edit

Summary

Apply transactions to create a new project or edit an existing one.

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
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.
custom.sealcode:is-current	Is current
custom.sealcode-claim-deadline	Claim deadline
custom.forum-category	Forum category URL
subtype	Change the object subtype.
mfa	Sign this transaction group with MFA.

parent

Choose a parent project to create a subproject beneath.

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

milestone

Choose a parent project to create a new milestone for.

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

space

Shift the object between spaces.

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

name

Rename the project

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

description

Short project description.

Key	Type	Description
type	const	description
value	string

icon

Change the project icon.

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

color

Change the project tag color.

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

slugs

Change project slugs.

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

members.add

Add members.

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

members.remove

Remove members.

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

members.set

Set members, overwriting the current value.

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

view

Change the view policy of the object.

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

edit

Change the edit policy of the object.

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

join

Change the join policy of the object.

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

custom.sealcode:is-current

Is current

Key	Type	Description
type	const	custom.sealcode:is-current
value	bool

custom.sealcode-claim-deadline

Claim deadline

Key	Type	Description
type	const	custom.sealcode-claim-deadline
value	epoch

custom.forum-category

Forum category URL

Key	Type	Description
type	const	custom.forum-category
value	string

subtype

Change the object subtype.

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

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