---
title: set_status
slug: docs/setstatus
docTags: 
createdAt: 2021-08-04T18:22:41.000Z
---

This allows you to add or remove a status from an applicant. 

# Parameters

| Name        | Type    | Required | Description                                                                                                                                                                                                                                                        |
| ----------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `action`    | string  | true     | `set_status`                                                                                                                                                                                                                                                       |
| `clogin_id` | integer | true     | This is a central login id which identifies a single user between any projects within your organization.                                                                                                                                                           |
| `group_id`  | integer | true     | This designates which project the action should be applied towards.                                                                                                                                                                                                |
| `doc`       | array   | true     | `doc` should be empty.                                                                                                                                                                                                                                             |
| `status_id` | integer | true     | This should be either a 0 to remove the current status, or the `status_id` which you would like to add. You can find these id's by looking at the editing status window (under tools in user management).<br /><br />**help article for editing statuses  \*\*\*** |

## Remove Status Example

This example would remove a status from the user.

### Call

:::CodeblockTabs
```curl
curl -X POST "https://www.regpack.com/reg/api2/users/" \ 
     -H "Content-Type: application/json" \ 
     -H "Accept: application/json" \ 
     -H "Api-Id: 15263" \ 
     -H "Api-user: api_admin@regpacks.com" \ 
     -H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \ 
     -d '{
    "action": "set_status",
    "group_id": 100909072,
    "clogin_id": 102670540,
    "doc": {},
    "status_id": 0
}
```

```python
import requests
import json
users_endpoint = https://www.regpack.com/reg/api2/users/
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Api-Id": "15263",
    "Api-user": "api_admin@regpacks.com",
    "Api-Token": "cd2e514f-7gab-3cde-62fg-51abcd4e7362",
}
payload = {
    "action": "set_status",
    "group_id": 100909072,
    "clogin_id": 102670540,
    "doc": {},
    "status_id": 0
}
set_status_remove_json = json.dumps(payload)
set_status_remove_response = requests.post(url=users_endpoint, 
                                           data=set_status_remove_json, 
                                           headers=headers, 
                                           timeout=10)
```
:::

### Response

```json
{
    "msg": "User status updated successfully.",
    "msg_type": "success",
    "users": [
        102670540
    ],
    "effected_users": 1,
    "success": true,
    "user_info": {
        "clogin_id": "102670540",
        "group_id": "100909072",
        "connected_to": "102670540"
    },
    "meta_info": {
        "u_name": "Miles Davis",
        "total_forms": "2",
        "completed_forms": "0",
        "total_user_forms": "2",
        "total_completed_user_forms": "0",
        "total_user_mandatory_forms": "2",
        "total_completed_user_mandatory_forms": "0",
        "total_order": "0.00",
        "total_paid": "0.00",
        "total_balance": "0.00",
        "status_id": "0",
        "status_name": null,
        "status_color": null,
        "application_date": "Dec 8th 2021 17:20",
        "application_date_raw": "2021-12-08 17:20:08",
        "u_comments": "0",
        "group_id": "100909072",
        "uid": "4085258",
        "clogin_id": "102670540",
        "excluded": "0",
        "connected_to": "102670540",
        "total_user_tags": "0",
        "user_tag_ids": null,
        "total_non_excluded_children": "1",
        "star": "0",
        "admin_initials": null,
        "admin_color": null,
        "assigned_admin_id": null
    }
}
```