Create a Number Group Membership

POST 
/number_groups/:NumberGroupId/number_group_memberships

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

Permissions

The API token must include the following scopes: Numbers.

Request

Path Parameters

NumberGroupId uuidrequired

Unique ID of the number group

application/json

Body

required

phone_number_id uuidrequired

The unique identifier of the Phone Number you would like to add to the Number Group.

Responses

201

CREATED

application/json

Schema

Schema

id uuid

The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically.

number_group_id uuid

The unique identifier of the Number Group this membership is associated with.

phone_number

object

A representation of the phone number this membership is associated with.

id uuid

name string

number string

capabilities string[]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "number_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "phone_number": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Jenny",
    "number": "+15558675309",
    "capabilities": [
      "voice",
      "sms",
      "mms",
      "fax"
    ]
  }
}

Loading...