Delete account users
|
1 |
POST /api/1/user/delete |
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. |
| userspecs | Body | false | Required | String | JSON formatted specs of the users to delete. One or more users may be in the userspecs. See userspecs documentation for details. Only the email field of userspecs is required. |
Note: See userspecs
Request
Following are example requests:
HTTP
|
1 2 3 4 5 6 7 |
POST /api/1/user/delete HTTP/1.1 Host: restapi.actonsoftware.com Authorization: Bearer 49eddd8dbcc51a6b798f90441cfe2bcb Content-Type: application/json Cache-Control: no-cache [{"email":"name3@domain.com"},{"email":"name4@domain.com"}] |
curl
|
1 |
curl -X POST "https://restapi.actonsoftware.com/api/1/user/delete" -H 'authorization: Bearer 49eddd8dbcc51a6b798f90441cfe2bcb' -H 'cache-control: no-cache' -H 'content-type: application/json' -H 'postman-token: 2c36669d-be28-9376-dbf9-1d30dc21c328' -d '[{"email":"e.fudd@domain.com"},{"email":"b.bunny@domain.com"}]' |
Response
A successful request results in an HTTP 200 response with a JSON object with the list of users selected.
Each user is deleted independently. A failure of one user will not prevent other users from being deleted.
The response will indicate which actions were successful and which were not. Each element will have “status” of “ok” or “error” along with “email” to indicate which user the element is for.
An example JSON response:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
[ { "email": "e.fudd@domain.com", "status": "ok" }, { "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.
