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

# Suspend a User — Shilo API Reference

> Suspend a user's membership in your Shilo integration. Does not delete their Shilo account or remove integration membership for Zillow Flex Advisor users.

Use this endpoint to suspend a user from your Shilo integration. Suspension removes the user's access within the context of your integration but does **not** delete their underlying Shilo account or affect memberships in other integrations. Note that Zillow Flex Advisor users are outside the scope of this endpoint and will not be affected by calls made here. This endpoint requires a **write-enabled** API key.

## Endpoint

```
DELETE https://api.shilo.ai/api/v1/users/{identifier}
```

## Authentication

Include your write-enabled API key in the request header:

```
x-api-key: YOUR_API_KEY
```

## Path Parameters

<ParamField path="identifier" type="string" required>
  The identifier used to look up the user. Three formats are supported:

  | Format              | Example                                   |
  | ------------------- | ----------------------------------------- |
  | Plain Shilo UUID    | `ee6f2136-b94a-4438-9335-3acf5b2a0d31`    |
  | Prefixed Shilo UUID | `id:ee6f2136-b94a-4438-9335-3acf5b2a0d31` |
  | External user ID    | `external_user_id:agent-1`                |
</ParamField>

## Response

A successful request returns HTTP `204 No Content` with no response body.

## Important Notes

<Warning>
  This endpoint suspends the user for **your integration only**. It does not permanently delete their Shilo account, and their data — including call history and signal scores — remains intact.
</Warning>

<Note>
  Zillow Flex Advisor users are not affected by this endpoint. Their integration membership cannot be removed through the API.
</Note>

## Error Codes

| Status | Meaning                                                     |
| ------ | ----------------------------------------------------------- |
| `400`  | Invalid or malformed identifier.                            |
| `403`  | Your API key is read-only. A write-enabled key is required. |

## Example Request

```bash theme={null}
curl -X DELETE "https://api.shilo.ai/api/v1/users/ee6f2136-b94a-4438-9335-3acf5b2a0d31" \
  -H "x-api-key: YOUR_API_KEY"
```

### Using external user ID

```bash theme={null}
curl -X DELETE "https://api.shilo.ai/api/v1/users/external_user_id:agent-1" \
  -H "x-api-key: YOUR_API_KEY"
```