http://docs.hostway.com/index.php?action=history&feed=atom&title=Accounts-accountId-action%3APOST 2026-05-23T18:09:56Z Revision history for this page on the wiki MediaWiki 1.18.0 http://docs.hostway.com/index.php?title=Accounts-accountId-action:POST&diff=2391&oldid=prev 2016-05-30T19:33:58Z

<p>1 revision</p> <table class='diff diff-contentalign-left'> <tr valign='top'> <td colspan='1' style="background-color: white; color:black;">← Older revision</td> <td colspan='1' style="background-color: white; color:black;">Revision as of 19:33, 30 May 2016</td> </tr></table>

Corinne.chui http://docs.hostway.com/index.php?title=Accounts-accountId-action:POST&diff=2390&oldid=prev 2016-05-07T01:26:09Z

<p>Created page with &quot;= POST /accounts/&#039;&#039;{accountId}&#039;&#039;/action = Initiate an action on an account __TOC__ == Request == &lt;code&gt;POST /accounts/&#039;&#039;{accountId}&#039;&#039;/action&lt;/code&gt; ==== Parameters ==== ; acc...&quot;</p> <p><b>New page</b></p><div>= POST /accounts/''{accountId}''/action =<br /> Initiate an action on an account<br /> __TOC__<br /> == Request ==<br /> &lt;code&gt;POST /accounts/''{accountId}''/action&lt;/code&gt;<br /> <br /> ==== Parameters ====<br /> ; accountId - ''string''<br /> : The Id of the account.<br /> <br /> === URI Parameters ===<br /> None.<br /> <br /> === Request Headers ===<br /> {{Authorization}}<br /> <br /> === Request Body ===<br /> &lt;nowiki&gt;<br /> {<br /> &quot;action&quot;: &quot;{action}&quot;,<br /> &quot;actionData&quot;: {actionData}<br /> }<br /> &lt;/nowiki&gt;<br /> <br /> ==== Parameters ====<br /> ; action - ''string''<br /> : The action that should be performed. Allowed values are:<br /> :: '''interFranchiseMigration''' - Submits a request to migrate this account to another franchise.<br /> <br /> ; actionData - ''dictionary''<br /> : Optional. Reserved for data specific for the requested action.<br /> <br /> == Response ==<br /> <br /> === Status Code ===<br /> ;202 Accepted<br /> : The request has been successfully initiated. Check the action status for future updates.<br /> <br /> ;400 Bad Request<br /> : The request body is not formatted correctly, is missing a required field, or contains an invalid value.<br /> <br /> ;403 Forbidden<br /> : Forbidden access to users that are not authorized for such access.<br /> <br /> ;404 Not Found<br /> : The account Id was not found.<br /> <br /> ;409 Conflict<br /> : An action has already been submitted for this account and is in progress.<br /> <br /> === Response Body ===<br /> None<br /> <br /> == Examples ==<br /> <br /> === Migrate an account to franchise &quot;franchise-2&quot; and set the new partner account Id to &quot;partner1&quot; ===<br /> '''Request'''<br /> &lt;nowiki&gt;<br /> POST {{APIBaseURL}}/accounts/account123/action<br /> Content-Type:application/json; Charset=UTF-8<br /> <br /> {<br /> action: &quot;interFranchiseMigration&quot;,<br /> actionData: {<br /> franchise: &quot;franchise-2&quot;,<br /> partnerAccountId: &quot;partner1&quot;<br /> }<br /> }<br /> &lt;/nowiki&gt;<br /> <br /> '''Response'''<br /> &lt;nowiki&gt;<br /> HTTP/1.1 202 Accepted<br /> &lt;/nowiki&gt;<br /> <br /> <br /> == See also ==<br /> * [[Account|Account Management API]]<br /> * [[Common Features]]<br /> <br /> {{disqus}}<br /> [[Category:Hostway API]]<br /> [[Category:Account Management API]]</div>

Kj.lee