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 phurls.edit
phurls.edit
phurls.edit
API Method: phurls.edit
API Method: phurls.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
Method Description
Transaction Summary
Transaction Summary
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. |
| 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. |
space
space
Shift the object between spaces.
| Key | Type | Description |
|---|---|---|
| type | const | space |
| value | phid | New space PHID. |
name
name
URL name.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New URL name. |
url
url
The URL to shorten.
| Key | Type | Description |
|---|---|---|
| type | const | url |
| value | string | New URL. |
alias
alias
The alias to give the URL.
| Key | Type | Description |
|---|---|---|
| type | const | alias |
| value | string | New alias. |
description
description
URL long description.
| Key | Type | Description |
|---|---|---|
| type | const | description |
| value | string | New URL description. |
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. |
subscribers.add
subscribers.add
Add subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.add |
| value | list<user> | List of PHIDs to add. |
subscribers.remove
subscribers.remove
Remove subscribers.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.remove |
| value | list<user> | List of PHIDs to remove. |
subscribers.set
subscribers.set
Set subscribers, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | subscribers.set |
| value | list<user> | List of PHIDs to set. |
comment
comment
Make comments.
| Key | Type | Description |
|---|---|---|
| type | const | comment |
| value | string | Comment to add, formatted as remarkup. |
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://admin.phacility.com/ --conduit-token <conduit-token> -- phurls.edit
$ curl https://admin.phacility.com/api/phurls.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://admin.phacility.com/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('phurls.edit', $api_parameters);
print_r($result);