Sign in
Number Groups

Update number group

Changes how a project Number Group is identified or selects a consistent sender for a recipient. Add or remove individual phone numbers through the Number Group Membership operations instead.

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.

put/api/relay/rest/number_groups/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the number group.

Request body

namestring required

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

sticky_senderboolean

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

Example request

{
  "name": "My Number Group"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

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

sticky_senderboolean required

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

phone_number_countinteger required

The number of phone numbers within the group.

Example response

{
  "name": "My Number Group",
  "phone_number_count": 4
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.