DELETE /api/users/:user_id

deactivate a user

Success Response Code: 200

Params

Param name Description
user_id
optional

id of user to deactivate


Value: Must be a Integer

Response Fields

user deactivated user User

Example Curl Commands

curl -X DELETE -v --basic -u "emily@socialcast.com:demo" "https://demo.socialcast.com/api/users/25.json"

Examples

DELETE 
{}
200
{
  "user": {
    "contact_info": {
      "email": "active'3@socialcast.com"
    },
    "manager": null,
    "custom_fields": [],
    "followable": false,
    "contact_id": null,
    "following_count": 0,
    "followers_count": 0,
    "status_message": null,
    "id": 3,
    "first_name": "J'øhn3",
    "last_name": "D'øe3",
    "name": "J'øhn3 D'øe3",
    "html_name": "J'øhn3 D'øe3",
    "url": "https://socialcast.socialcast.test/users/3-j%C3%B8hn3d%C3%B8e3",
    "avatars": {
      "is_system_default": false,
      "id": 1,
      "square16": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square16.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170321%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170321T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=0802a2fb5a2006801a7207c2c025aaac2b6cd98562da98753119360092a60cc3",
      "square30": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square30.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170321%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170321T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=24e99ce07c3fa2b6e20eb2550df91fc59846ee1b8000d16bcf4ecf1fc48f9b63",
      "square45": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square45.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170321%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170321T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=d35f13bdb597770b4f994ed5bb8cbcfa07a4f908826e2eaab323bdd863a6b8e1",
      "square70": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square70.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170321%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170321T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=d7604528a7caa7ae80406022bcad6c36e69c6f50f2dbadbe14041b36f18f4d47",
      "square140": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails_square140.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170321%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170321T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=8cf5952ffa7ad046c3013c22504bebfafda5f340642ca91f1a6604c848c54cc7",
      "original": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/1/rails.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20170321%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170321T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=86bc6b5253c0dc3841715e7c8a05c5a26e86da8c4b768f1f0cffe943b5a48207"
    },
    "username": "Jøhn3Døe3",
    "active": false,
    "terminated": true,
    "inactive": false,
    "role": "member",
    "type": "User",
    "title": null,
    "out_of_office": false,
    "out_of_office_on": null,
    "back_in_office_on": null,
    "company_login": null
  }
}