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.
Conduit project.edit
project.edit
project.edit
API Method: project.edit
API Method: project.edit
Login Required: This method requires authentication. You must log in before you can make calls to it.
- 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
Method Description
Transaction Summary
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. |
| subtype | Change the object subtype. |
| mfa | Sign this transaction group with MFA. |
parent
parent
Choose a parent project to create a subproject beneath.
| Key | Type | Description |
|---|---|---|
| type | const | parent |
| value | phid | PHID of the parent project. |
milestone
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
space
Shift the object between spaces.
| Key | Type | Description |
|---|---|---|
| type | const | space |
| value | phid | New space PHID. |
name
name
Rename the project
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New project name. |
description
description
Short project description.
| Key | Type | Description |
|---|---|---|
| type | const | description |
| value | string |
icon
icon
Change the project icon.
| Key | Type | Description |
|---|---|---|
| type | const | icon |
| value | string | New project icon. |
color
color
Change the project tag color.
| Key | Type | Description |
|---|---|---|
| type | const | color |
| value | string | New project tag color. |
slugs
slugs
Change project slugs.
| Key | Type | Description |
|---|---|---|
| type | const | slugs |
| value | list<string> | New list of slugs. |
members.add
members.add
Add members.
| Key | Type | Description |
|---|---|---|
| type | const | members.add |
| value | list<user> | List of PHIDs to add. |
members.remove
members.remove
Remove members.
| Key | Type | Description |
|---|---|---|
| type | const | members.remove |
| value | list<user> | List of PHIDs to remove. |
members.set
members.set
Set members, overwriting the current value.
| Key | Type | Description |
|---|---|---|
| type | const | members.set |
| value | list<user> | List of PHIDs to set. |
view
view
Change the view policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | view |
| value | string | New policy PHID or constant. |
edit
edit
Change the edit policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | edit |
| value | string | New policy PHID or constant. |
join
join
Change the join policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | join |
| value | string | New policy PHID or constant. |
subtype
subtype
Change the object subtype.
| Key | Type | Description |
|---|---|---|
| type | const | subtype |
| value | string | New object subtype key. |
mfa
mfa
Sign this transaction group with MFA.
| Key | Type | Description |
|---|---|---|
| type | const | mfa |
| value | bool |
Call Method
Call Method
Examples
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://gitpull.it/ --conduit-token <conduit-token> -- project.edit
$ curl https://gitpull.it/api/project.edit \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://gitpull.it/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('project.edit', $api_parameters);
print_r($result);
Public contents are in Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) or GNU Free Documentation License (at your option) unless otherwise noted. · Contact / Register