Delete account user
|
1 |
DELETE /api/1/user/{email} |
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | Header | False | Required | String (Bearer {access token}) | Pass the authentication token that was granted when you authorized access. |
| Path | False | True | String | Email address for the user to delete from the account. |
Request
Following are example requests:
HTTP
|
1 2 3 4 5 |
DELETE /api/1/user/elmer.fudd@mydomain.com HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer 1d55dd5b8123ee4bfa72acb77a9d3a5 Cache-Control: no-cache Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW |
cURL
|
1 |
curl -X DELETE "https://restapi.actonsoftware.com/api/1/user/" -H 'authorization: Bearer 49eddd8dbcc51a6b798f90441cfe2bcb' -H 'cache-control: no-cache' -H 'content-type: application/x-www-form-urlencoded' |
Response
A successful request results in an HTTP 200 response with a JSON object with the result.
The response will indicate success or failure and the reason if a failure. Each element will have “status” of “ok” or “error” along with “email”.
An example JSON responses:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
Success example: { "email": "e.fudd@domain.com", "status": "ok" } Failure example: { "email": "b.bunny@domain.com", "status": "error", "errorCode": "PUBLIC_USER_DOES_NOT_EXIST", "errorMessage": "User does not exist.", "errorCodeId": 10148 } } |
In the above example one user was deleted and the other user failed due to the user not existing.
