> ## Documentation Index
> Fetch the complete documentation index at: https://botsify.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Change User Status — POST /api/v1/user/change-status

> Bulk-update the status of one or more Botsify users by supplying their IDs in the request body, with optional scoping to a specific user segment.

Use this endpoint to bulk-update the status of one or more users in your Botsify workspace. The new status is supplied as a path parameter, and you provide the list of target user IDs in the request body. Optionally, you can scope the operation to a specific segment by including a `segment_id`. Authentication requires a valid Bearer token.

## Path Parameters

<ParamField path="status" type="string" required>
  The new status to apply to the specified users. This value is included directly in the URL path (e.g., `/api/v1/user/change-status/active`).
</ParamField>

## Request Body

<ParamField body="user_ids" type="array of integers" required>
  An array of integer user IDs identifying the users whose status you want to update. You must supply at least one ID.
</ParamField>

<ParamField body="segment_id" type="integer">
  An optional segment ID. When provided, the status change is applied only to users who both appear in `user_ids` and belong to the specified segment.
</ParamField>

## Example Request

```bash theme={null}
curl --request POST \
  --url https://app.botsify.com/api/v1/user/change-status/active \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "user_ids": [101, 102, 103],
    "segment_id": 7
  }'
```

## Response

A successful request returns a JSON object confirming the number of users whose status was updated, along with the applied status value. If any user IDs were not found or did not match the segment filter, the response may include a list of skipped IDs.

```json theme={null}
{
  "updated": 3,
  "status": "active",
  "skipped": []
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.