Sign in

v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB
Number Group Membership

Create number group membership

Adds a phone number to a number 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.

post/api/relay/rest/number_groups/{NumberGroupId}/number_group_memberships

Path parameters

NumberGroupIdstring uuid required

Universal Unique Identifier.

Unique ID of the number group.

Request body

phone_number_idstring uuid required

Universal Unique Identifier.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

number_group_idstring uuid required

Universal Unique Identifier.

created_atstring required

The date and time when the membership was created.

updated_atstring required

The date and time when the membership was last updated.

Example response

{
  "phone_number": {
    "name": "Jenny",
    "number": "+15558675309",
    "capabilities": [
      "voice",
      "sms",
      "mms",
      "fax"
    ]
  },
  "created_at": "2023-01-15T10:30:00Z",
  "updated_at": "2023-01-15T10:30:00Z"
}