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 /api/users/50.json
{}
200
{
  "user": {
    "contact_info": {
      "email": "active'46@socialcast.com"
    },
    "manager": null,
    "custom_fields": [],
    "followable": false,
    "contact_id": null,
    "following_count": 0,
    "followers_count": 0,
    "status_message": null,
    "id": 50,
    "first_name": "J'øhn46",
    "last_name": "D'øe46",
    "name": "J'øhn46 D'øe46",
    "html_name": "J'øhn46 D'øe46",
    "url": "https://socialcast.socialcast.test/users/50-j%C3%B8hn46d%C3%B8e46",
    "avatars": {
      "is_system_default": false,
      "id": 4,
      "square16": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square16.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20181205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20181205T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=e764fafb7ae0ebaac2e85cfbde32a36082d931f890aa0b0fde673cbd433bc7b8",
      "square30": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square30.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20181205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20181205T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=97af4610dea6d2ca7a6f949e8e61125a4f7113216bf9f8855548ca4f7ee59a20",
      "square45": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square45.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20181205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20181205T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=c04a2782e2f83b86e4d31bbdeb68e33f49ce9d68155d0a2720ae1727bc97b762",
      "square70": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square70.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20181205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20181205T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=98cf63fabf99eae1511e9597b872af305797d45203b32c97f0119874cb184797",
      "square140": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails_square140.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20181205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20181205T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=caeafe2d8b2852de5f75d9b28f63e4fb77f61acdd4edad3aab8527696c98a64e",
      "original": "https://s3.amazonaws.com/socialcast_test/tenants/1/profile_photos/4/rails.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=stubbed-akid%2F20181205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20181205T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=06e0a592a85f50ac95dc62a8242d0b4862a7cae52191a96da6635b44bb5bbdd8"
    },
    "username": "Jøhn46Døe46",
    "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
  }
}