Loading...
 

Hold or Unhold Account


HTTP VerbPUT
URI Template/account/{accID}/hold?hold={true|false}
MIME Typeapplication/vnd.pncp.v.1.0+json onwards
Normal HTTP Response Code202 Accepted
Invoked byResellers can invoke this for accounts in their hierarchy but not for their own account. End-clients cannot invoke this.
Response ModeAsynchronous.

Sample Request

PUT /pncp-external-api-rest/account/4663/hold?hold=true HTTP/1.1
Accept: application/vnd.pncp.v.5.0+json
Authorization: PNCP ODQ4M2JhZWM2ZWFkNjUQmdXZ0hKZzlEdlAvcmc3VT0=
Content-Type: application/vnd.pncp.v.5.0+json
Content-Length: 19
User-Agent: Jakarta Commons-HttpClient/3.1
Host: YOUR_API_URL

{
   "sendEmail":false
}

Sample Response

HTTP/1.1 202 Accepted
Server: Apache-Coyote/1.1
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Cache-Control: no-cache
Cache-Control: no-store
Content-Type: application/vnd.pncp.v.5.0+json
Transfer-Encoding: chunked
Date: Wed, 18 Apr 2012 16:56:36 GMT

{
   [
      "resourceURL":"/task/c916ceae-7e26-497d-a50b-a249ae3bc3c7"
   ]
}

Field Info

Field Name
Required
sendEmail
YES

Notes

  • If this method is invoked with hold set to true (i.e. account will be held), all child accounts in the hierarchical tree below the account will be held as well.