latestOpenAPI 3.1.0MIT2026-08-102046250.0 KB

67cb925f1c81

Groups

Replace a group

The replace operation will replace all parameters, including members, of an existing group with new values.

Replacing a group targeted by a batch message scheduled in the future is allowed and changes will be reflected when the batch is sent.

put/xms/v1/{service_plan_id}/groups/{group_id}

Request body

idstring

The ID used to reference this group.

namestring

Name of group if set.

sizeinteger

The number of members currently in the group.

created_atstring date-time

Timestamp for group creation. Format: YYYY-MM-DDThh:mm:ss.SSSZ

modified_atstring date-time

Timestamp for when the group was last updated. Format: YYYY-MM-DDThh:mm:ss.SSSZ

child_groupsMtGroupId[]

Phone numbers MSIDNs of child group will be included in this group. If present then this group will be auto populated.

Constraints: Elements must be group IDs.

membersstring[]

Initial list of phone numbers in E.164 format MSISDNs for the group.

Example request

{
  "id": "01FC66621VHDBN119Z8PMV1QPQ",
  "name": "My new customers",
  "size": 2,
  "child_groups": [
    "01FC66621VHDBN119Z8PMV1AHY"
  ],
  "auto_update": {
    "to": "+15551231234",
    "add": {
      "first_word": "Sinch",
      "second_word": "JOIN"
    },
    "remove": {
      "first_word": "LEAVE"
    }
  },
  "members": [
    "+15551231234",
    "+15551256344"
  ]
}

Response

A successful response, or an Error.