PUT login/users/:user id/deactivate
(Difference between revisions)
| Line 1: | Line 1: | ||
| − | + | == Description == | |
| + | |||
| + | Deactivates an user for login. | ||
| + | |||
| + | == Resource URL == | ||
| + | |||
| + | PUT https://api.socialidnow.com/v1/marketing/login/users/:user_id/deactivate | ||
| + | |||
| + | == Parameters == | ||
| + | |||
| + | === URL Parameters === | ||
| + | |||
| + | {| | ||
| + | ! align="left" width="200px" | user_id | ||
| + | | width="200px" | required | ||
| + | | user identifier. | ||
| + | |} | ||
| + | |||
| + | == Authentication == | ||
| + | |||
| + | This API requires Marketing Account authentication. See [[Authentication]]. | ||
| + | |||
| + | == Response == | ||
| + | |||
| + | ==== Response Status ==== | ||
| + | {| | ||
| + | ! align="left" width="200px" | ok (200) | ||
| + | | The user was deactivated successfully. | ||
| + | |- | ||
| + | ! align="left" width="200px" | unauthorized (401) | ||
| + | | The authentication is wrong. See [[Authentication]]. | ||
| + | |- | ||
| + | ! align="left" width="200px" | not_found (404) | ||
| + | | The user was not found. | ||
| + | |- | ||
| + | ! align="left" width="200px" | internal_server_error (500) | ||
| + | | An unknown error happened. | ||
| + | |} | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | === Request === | ||
| + | |||
| + | Deactivates the user "340": | ||
| + | |||
| + | curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users/340/deactivate' \ | ||
| + | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | ||
| + | |||
| + | === Response === | ||
| + | |||
| + | ==== Response Headers ==== | ||
| + | |||
| + | HTTP/1.1 200 Ok | ||
| + | Status: 200 | ||
Revision as of 03:04, 4 November 2014
Contents |
Description
Deactivates an user for login.
Resource URL
PUT https://api.socialidnow.com/v1/marketing/login/users/:user_id/deactivate
Parameters
URL Parameters
| user_id | required | user identifier. |
|---|
Authentication
This API requires Marketing Account authentication. See Authentication.
Response
Response Status
| ok (200) | The user was deactivated successfully. |
|---|---|
| unauthorized (401) | The authentication is wrong. See Authentication. |
| not_found (404) | The user was not found. |
| internal_server_error (500) | An unknown error happened. |
Examples
Request
Deactivates the user "340":
curl -iX PUT 'https://api.socialidnow.com/v1/marketing/login/users/340/deactivate' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
