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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=a880159012d55f77543b641c54f4ef167ced93478840f87a405163550b0bd426",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=7fdcb7c429e884cf3d0e4f6b7a82c07304e074e8522b705d1ddd6ef9bda1a95b",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=324f0242124b2033aab8631fa4e8f8f241e087baa62af195f506a45b1f07815f",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=cff5fe4b91b51bb795562517bfd8ee4baa47cddb8e808e5ae7869a04ede5b11b",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=bb73275870bebc3815137dfcf2941dffde1b7bf56bd6354c26d4b88eb42f7493",
      "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%2F20170917%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20170917T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=fd0d74ae1db62e0e7ae16725a148c66d64fb0172bae353cfb6291af648c7d1ed"
    },
    "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
  }
}