×

Login to Safe Shepherd

Recover your password

Safe Shepherd API Documentation

Deactivate user

Deactivates a user from Safe Shepherd service.

POST /api/:integration_name/:api_key/v2/users/:id/deactivate(.:format)

Parameters

api_key
API access key - String*
api_secret
API secret key - String*
id
User id returned during user creation - Integer*
secret
Secret associated with user account during creation - Integer*

Returns

HTTP 401 - Unauthorized

If api_key missing or invalid, or user-secret failed authorization.

HTTP 404 - Not Found

If user is not found.

HTTP 400 - Bad Request

If user inactive.

HTTP 200 - Success

If user newly deactivated.

Returns JSON/XML-encoded user struct

Notes

A user account is considered in good standing from creation until this endpoint is called. Thus, if the user fails payment or cancels service, this method should be called.