# Call Forwarding

## Get call forwarding for a line

**get** `/api/lines/{sendblue_number}/call-forwarding`

Returns the current call forwarding number for a dedicated phone line.

Per-line forwarding takes priority over the company default forwarding number
but is overridden by seat-level forwarding when a seat has a forwarding number set.

**Priority order:** seat forwarding → per-line forwarding → company default forwarding

### Path Parameters

- `sendblue_number: string`

### Returns

- `forwarding_number: string`

  The number calls are forwarded to, or null if not set

- `sendblue_number: string`

  The Sendblue phone number (E.164)

### Example

```http
curl https://api.sendblue.co/api/lines/$SENDBLUE_NUMBER/call-forwarding \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"
```

#### Response

```json
{
  "forwarding_number": "+16692138010",
  "sendblue_number": "+12125550101"
}
```

## Set call forwarding for a line

**put** `/api/lines/{sendblue_number}/call-forwarding`

Sets a call forwarding number for a specific dedicated phone line.
Inbound calls to this line will be forwarded to the specified number.

The `forwarding_number` is normalized to E.164 format before storage.
US numbers can be supplied in local format (e.g. `2125550199`).

### Path Parameters

- `sendblue_number: string`

### Body Parameters

- `forwarding_number: string`

  Phone number to forward calls to (E.164 or US local format)

### Returns

- `forwarding_number: string`

  The number calls are forwarded to, or null if not set

- `sendblue_number: string`

  The Sendblue phone number (E.164)

### Example

```http
curl https://api.sendblue.co/api/lines/$SENDBLUE_NUMBER/call-forwarding \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET" \
    -d '{
          "forwarding_number": "+16692138010"
        }'
```

#### Response

```json
{
  "forwarding_number": "+16692138010",
  "sendblue_number": "+12125550101"
}
```

## Clear call forwarding for a line

**delete** `/api/lines/{sendblue_number}/call-forwarding`

Removes the per-line call forwarding number. After clearing, inbound calls
will fall back to the company default forwarding number (if configured).

This operation is idempotent — calling it on a line with no forwarding set
returns 200 with `forwarding_number: null`.

### Path Parameters

- `sendblue_number: string`

### Returns

- `forwarding_number: string`

  The number calls are forwarded to, or null if not set

- `sendblue_number: string`

  The Sendblue phone number (E.164)

### Example

```http
curl https://api.sendblue.co/api/lines/$SENDBLUE_NUMBER/call-forwarding \
    -X DELETE \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"
```

#### Response

```json
{
  "forwarding_number": "+16692138010",
  "sendblue_number": "+12125550101"
}
```

## Domain Types

### Call Forwarding Retrieve Response

- `CallForwardingRetrieveResponse object { forwarding_number, sendblue_number }`

  - `forwarding_number: string`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: string`

    The Sendblue phone number (E.164)

### Call Forwarding Update Response

- `CallForwardingUpdateResponse object { forwarding_number, sendblue_number }`

  - `forwarding_number: string`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: string`

    The Sendblue phone number (E.164)

### Call Forwarding Delete Response

- `CallForwardingDeleteResponse object { forwarding_number, sendblue_number }`

  - `forwarding_number: string`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: string`

    The Sendblue phone number (E.164)