Delete Account User(s)
POST https://restapi.actonsoftware.com/api/1/user/delete
This endpoint allows you to delete a user or multiple users from the account.
Parameters
Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
---|---|---|---|---|---|
Authorization: | Header | False | Required | String | Insert your generated access token. ("Bearer {access token}") |
Body | false | Required | String | A RAW body with JSON containing the userspecs data. |
See userspecs documentation for details on how to create the JSON required for the body of this request.
Response
The users are deleted independently and a failure of one user will not prevent other users from being deleted. The status of “ok” or “error” along with an email will indicate if the user was added successfully or not.
[ { "email": "[email protected]", "status": "ok" }, { "email": "[email protected]", "status": "error", "errorCode": "PUBLIC_USER_DOES_NOT_EXIST", "errorMessage": "User does not exist.", "errorCodeId": 10148 } ]
Code Examples
curl -X POST "https://restapi.actonsoftware.com/api/1/user/delete" -H 'authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs' -H 'content-type: application/json' -d '[{"email":"[email protected]"},{"email":"[email protected]"}]'
import requests url = "https://restapi.actonsoftware.com/api/1/user/delete" payload = "[{\"email\":\"[email protected]\"},{\"email\":\"[email protected]\"}]" headers = { 'authorization': "Bearer b9497249-5bd4-3a86-9494-b1bfe2cee147", 'content-type': "application/json", } response = requests.request("POST", url, data=payload, headers=headers) print(response.text)