## Hide the call card

`POST /v1/calls/:callId/hide`

Removes the active-call card shown over open Bitrix24 windows for the specified user. Symmetric to [`POST /v1/calls/:callId/show`](./show.md).

## Parameters

| Parameter | In | Type | Required | Description |
|----------|---|-----|:-----:|---------|
| `callId` | path | string | yes | `CALL_ID` from the [`POST /v1/calls/register`](./register.md) response |

## Request fields (body)

| Parameter | Type | Required | Default | Description |
|----------|-----|:-----:|-----------|---------|
| `userId` | number | yes | — | ID of the Bitrix24 user whose card is hidden. A positive integer. A numeric string such as `"42"` is also accepted. [Employees](/docs/entities/users) |

## Examples

### curl — personal key

```bash
curl -X POST https://vibecode.bitrix24.com/v1/calls/CALL_ID/hide \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userId": 1}'
```

### curl — OAuth application

```bash
curl -X POST https://vibecode.bitrix24.com/v1/calls/CALL_ID/hide \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId": 1}'
```

### JavaScript — personal key

```javascript
const callId = 'externalCall.00b1e735843c558431be668e3687a58b.1777974304'

const res = await fetch(`https://vibecode.bitrix24.com/v1/calls/${callId}/hide`, {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 1 }),
})

const { success, data } = await res.json()
```

### JavaScript — OAuth application

```javascript
const callId = 'externalCall.00b1e735843c558431be668e3687a58b.1777974304'

const res = await fetch(`https://vibecode.bitrix24.com/v1/calls/${callId}/hide`, {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 1 }),
})

const { success, data } = await res.json()
```

## Response fields

| Field | Type | Description |
|------|-----|---------|
| `data` | boolean | `true` — the card was hidden successfully, `false` — the card was not found: the call does not exist or has already finished |

## Response example

```json
{
  "success": true,
  "data": true
}
```

## Error response example

400 — a required parameter is missing:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: userId (positive integer)"
  }
}
```

## Errors

| HTTP | Code | Description |
|------|-----|---------|
| 400 | `MISSING_PARAMS` | `userId` is missing or is not recognized as a positive integer |
| 401 | `MISSING_API_KEY` | The `X-Api-Key` header is missing |
| 401 | `INVALID_API_KEY` | Invalid API key |
| 401 | `TOKEN_MISSING` | The API key has no Bitrix24 tokens configured |
| 401 | `KEY_INACTIVE` | The API key is inactive or revoked |
| 403 | `SCOPE_DENIED` | The key is missing the `telephony` scope |
| 422 | `BITRIX_ERROR` | Bitrix24 returned an error (text in `error.message`) |
| 429 | `RATE_LIMITED` | Request limit exceeded |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable |

Full list of common API errors — [Errors](/docs/errors).

## Known specifics

**The success indicator is the `data` field, not the HTTP status.** For a non-existent `callId`, Bitrix24 returns `HTTP 200` with `data: false`. Check the field value, not the response code.

**`userId` does not have to match the user who registered the call.** The card can be hidden for any user in the Bitrix24 account.

## See also

- [Show the card](./show.md)
- [Register a call](./register.md)
- [Finish a call](./finish.md)