Create a Number Group

POST 
/number_groups

To create a new Number Group, you send a POST request to the Number Group resource.

Permissions

The API token must include the following scopes: Numbers.

Request

application/json

Body

required

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

Responses

201

CREATED

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 (from schema)

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