Deactivate User

DELETE

https://api.sfox.com/v1/enterprise/account/:user_id

Deactivates a user account.

Deactivating the account will remove any connection between you and the user's account.

You will no longer be able to generate User Auth Tokens for this user.
The user will no longer appear when retrieving End Users.

Requests to deactivate a user will fail unless the user's account balances are zero. Please be sure to have the user withdraw balances from their account prior to attempting deactivation.

Request

Path Parameters

Name

Type

Description

user_id required

string

User ID of the user's account to be disabled

Example Requests

curl -X DELETE \
-H "Authorization: Bearer ${ENTERPRISE_API_KEY}"  \
'https://api.sfox.com/v1/enterprise/account/${USER_ID}'

const axios = require('axios');

const config = {
  method: 'delete',
  url: 'https://api.sfox.com/v1/enterprise/account/${USER_ID}',
  headers: {
    'Authorization': `Bearer ${process.env.ENTERPRISE_API_KEY}`
  }
}

axios(config)
  .then(response => {
    console.log(response.status)
    console.log(response.data)
  }).catch(err => {
    console.error(err.response.status)
    console.error(err.respones.data)
  });

import requests
import os

data = requests.delete(
  "https://api.sfox.com/v1/enterprise/account/${USER_ID}",
  headers={
    "Authorization": f"Bearer {os.environ['${ENTERPRISE_API_KEY}']}"
  }
)
print(data.status_code)
print(data.json())

Response

Responses

200 OK

No body returned

422 Unprocessable Content

{
    "error": "Can not disable account with non-zero balances. Please remove all balances and try again."
}

404 Not Found

{
"error": "The account does not exist to be disabled."
}

PreviousSubmit Documents (SFTP)NextPayments

Last updated 7 months ago

hashtagRequest

hashtagPath Parameters

hashtagExample Requests

hashtagResponse

hashtagResponses

Request

Path Parameters

Example Requests

Response

Responses