Skip to main content

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​

Body

required

    name stringrequired

    The name given to the number group. Helps to distinguish different groups within your project.

    sticky_sender boolean

    Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. Defaults to false.

Responses​

CREATED

Schema

    id uuidrequired

    The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically.

    name stringrequired

    The name given to the number group. Helps to distinguish different groups within your project.

    sticky_sender boolean

    Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one. Defaults to false.

    phone_number_count number

    The number of phone numbers within the group.

Loading...