---
title: "Set-NectarNumber"
slug: "set-nectarnumber"
updated: 2023-05-15T17:41:31Z
published: 2023-05-15T17:41:31Z
canonical: "support.nectarcorp.com/set-nectarnumber"
---

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

# Set-NectarNumber

Makes changes to one or more phone numbers.

## Syntax

```
Set-NectarNumber
  -PhoneNumber  <String>
  -NumberState  <String>
  -Comment  <String>
  -TenantName  <String>
  -Identity  <String>
```

## Examples

### Example 1

```
Set-NectarNumber +12223334444 -NumberState RESERVED
```

Reserves the number +12223334444

## Parameters

**-PhoneNumber <String>** A phone number to make changes to. Must be an exact match.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-NumberState <String>** Change the state of a phone number to either UNUSED or RESERVED. A number marked USED cannot be modified.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-Comment <String>** A comment to add to a reserved phone number.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-TenantName <String>** The name of the Nectar DXP tenant. Used in multi-tenant configurations.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-Identity <String>**

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |