Update a Number Group

PUT 
https://YOUR_SPACE.signalwire.com/api/relay/rest/number_groups/:id

Updates the specific Number Group by setting the values of any parameters passed in. Any parameters not provided will be unchanged.

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

id uuidrequired

Unique ID of the number group

application/json

Bodyrequired

namestringrequired
The name given to the number group. Helps to distinguish different groups within your project.
Example: My Number Group

Responses

200

OK

application/json

Schema

Schema

iduuidrequired
The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically.
namestringrequired
The name given to the number group. Helps to distinguish different groups within your project.
Example: My Number Group
sticky_senderboolean
Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. Defaults to false.
Example: false
phone_number_countnumber
The number of phone numbers within the group.
Example: 4

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "My Number Group",
  "sticky_sender": false,
  "phone_number_count": 4
}

Authorization: http

name: basic_authtype: httpscheme: basic

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://YOUR_SPACE.signalwire.com/api/relay/rest/number_groups/:id");
request.Headers.Add("Accept", "application/json");
var content = new StringContent("{\n  \"name\": \"My Number Group\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://YOUR_SPACE.signalwire.com/api/relay/rest

Auth

Project ID

API Token

Parameters

id — pathrequired

Body required

{
  "name": "My Number Group"
}

ResponseClear

Click the Send API Request button above and see the response here!