Delete Account User(s)

Scott Wallace
Scott Wallace
  • Updated
POST https://api.actonsoftware.com/api/1/user/delete

This endpoint allows you to delete a user or multiple users from the account.

Customers wanting to access our API via our gateway in the EU can use this link: 

POST https://api-eu.actonsoftware.com/api/1/user/delete

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": "john.doe@act-on.com",
    "status": "ok"
  },
  {
    "email": "john.doe@act-on.com",
    "status": "error",
    "errorCode": "PUBLIC_USER_DOES_NOT_EXIST",
    "errorMessage": "User does not exist.",
    "errorCodeId": 10148
  }
]

 

Code Examples

cURL

curl -X POST "https://api.actonsoftware.com/api/1/user/delete" -H 'authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs' -H 'content-type: application/json' -d '[{"email":"john.doe@act-on.com"},{"email":"john.doe@act-on.com"}]'

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request