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%2F20180810%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180810T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=60f6cbd733b1b341a9e6146cef562ef37c8005b69f7a1e3bf73393889e5f2a1c",
      "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%2F20180810%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180810T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=21e2e9cbf60f6b209c7fe4de80fede4491c0da82a4b3871c8f5f5faf46d7bada",
      "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%2F20180810%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180810T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=bd564dbe98292c2b1e988a8c74f47661e8fdaed9156671e86a0d3ba2a7329985",
      "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%2F20180810%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180810T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=3617602a0e9f5e5b5e897a9f2e0146fbdab8922d53b1589ee3a493ff0249ef27",
      "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%2F20180810%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180810T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=aca8f6a062b417796332cec755c6e4591519ce72bb54e65fb63873f9bd77808d",
      "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%2F20180810%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180810T234500Z&X-Amz-Expires=518400&X-Amz-SignedHeaders=host&X-Amz-Signature=f7c482cfc42b7705e7142fec0ddb622285fb6465df07cd975598818b05a6b515"
    },
    "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
  }
}