Remove a Household Member
Request Details
| Item | Value |
| Description | Remove a member from a household. |
| Method | DELETE |
| Endpoint | https://[environment]api[client_id].crowdtwist.com/v2/household/[household_id]/user/[user_id]?api_key=[api_key]¤t_user=[member_id] |
Request
| Field Name | Sample Value | Required | Format | Notes |
| URL PARAMETERS | ||||
| household_id | 10 | Yes | Integer | The id of the household. |
| user_id | 238901577 | Yes | Integer | The id of the member to be removed (CrowdTwist User ID) |
| QUERY STRING PARAMETERS | ||||
| api_key | QWERTYUIOP | Yes | String | |
| current_user | 240835353 | Yes | Integer | The member who is performing this action. This member must be the household owner. (CrowdTwist User ID) |
Successful Response
| Field Name | Sample Value | Format | Description |
| removed_user_id | 238901577 | Integer | The user id of the member who was removed from this household (CrowdTwist User ID) |
Sample Successful Response
{
"removed_user_id": 238901577
}
Error Responses
| Error Code | Description |
| 404 | Unable to find household. |
| 404 | Unable to find member. |
| 400 | The owner of the household cannot be removed. |
| 400 | Only the household owner can remove this member. |