Create number group membership

View as MarkdownOpen in Claude
Adds one project-owned phone number to a Number Group by phone-number ID. Use it to build or expand a sender pool after creating the group; this operation does not purchase or import the number. A phone number can belong to more than one group. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

NumberGroupIdstringRequiredformat: "uuid"
Unique ID of the number group.

Request

This endpoint expects an object.
phone_number_idstringRequiredformat: "uuid"
The phone number ID to add to the group.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the Number Group Membership on SignalWire. This can be used to delete the membership programmatically.
number_group_idstringformat: "uuid"
The unique identifier of the Number Group this membership is associated with.
phone_numberobject
A representation of the phone number this membership is associated with.
created_atstring
The date and time when the membership was created.
updated_atstring
The date and time when the membership was last updated.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error