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 phame.blog.edit
phame.blog.edit
phame.blog.edit
API Method: phame.blog.edit
API Method: phame.blog.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 |
|---|---|
| name | Retitle the blog. |
| subtitle | Change the blog subtitle. |
| description | Change the blog description. |
| domainFullURI | Change the blog full domain URI. |
| parentSite | Change the blog parent site name. |
| parentDomain | Change the blog parent domain. |
| status | Active or archive the blog. |
| view | Change the view policy of the object. |
| edit | Change the edit policy of the object. |
| interact | Change the interaction 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. |
| mfa | Sign this transaction group with MFA. |
name
name
Retitle the blog.
| Key | Type | Description |
|---|---|---|
| type | const | name |
| value | string | New blog title. |
subtitle
subtitle
Change the blog subtitle.
| Key | Type | Description |
|---|---|---|
| type | const | subtitle |
| value | string | New blog subtitle. |
description
description
Change the blog description.
| Key | Type | Description |
|---|---|---|
| type | const | description |
| value | string | New blog description. |
domainFullURI
domainFullURI
Change the blog full domain URI.
| Key | Type | Description |
|---|---|---|
| type | const | domainFullURI |
| value | string | New blog full domain URI. |
parentSite
parentSite
Change the blog parent site name.
| Key | Type | Description |
|---|---|---|
| type | const | parentSite |
| value | string | New blog parent site name. |
parentDomain
parentDomain
Change the blog parent domain.
| Key | Type | Description |
|---|---|---|
| type | const | parentDomain |
| value | string | New blog parent domain. |
status
status
Active or archive the blog.
| Key | Type | Description |
|---|---|---|
| type | const | status |
| value | string | New blog status constant. |
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. |
interact
interact
Change the interaction policy of the object.
| Key | Type | Description |
|---|---|---|
| type | const | interact |
| value | string | New policy PHID or constant. |
projects.add
projects.add
Add project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.add |
| value | list<project> | List of PHIDs to add. |
projects.remove
projects.remove
Remove project tags.
| Key | Type | Description |
|---|---|---|
| type | const | projects.remove |
| value | list<project> | List of PHIDs to remove. |
projects.set
projects.set
Set project tags, overwriting current value.
| Key | Type | Description |
|---|---|---|
| type | const | projects.set |
| value | list<project> | List of PHIDs to set. |
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. |
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://phab.xyz/ --conduit-token <conduit-token> -- phame.blog.edit
$ curl https://phab.xyz/api/phame.blog.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://phab.xyz/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('phame.blog.edit', $api_parameters);
print_r($result);