Groups
Update a group
With the update group operation, you can add and remove members in an existing group as well as rename the group.
This method encompasses a few ways to update a group:
- By using add and remove arrays containing phone numbers, you control the group movements. Any list of valid numbers in E.164 format can be added.
- By using the auto_update object, your customer can add or remove themselves from groups.
- You can also add or remove other groups into this group with add_from_group and remove_from_group.
Other group update info
- The request will not be rejected for duplicate adds or unknown removes.
- The additions will be done before the deletions. If an phone number is on both lists, it will not be apart of the resulting group.
- Updating a group targeted by a batch message scheduled in the future is allowed. Changes will be reflected when the batch is sent.
post/xms/v1/{service_plan_id}/groups/{group_id}
Request body
Example request
{
"add_from_group": "01FC66621VHDBN119Z8PMV1QPU",
"remove_from_group": "01FC66621VHDBN119Z8PMV1AHY",
"auto_update": {
"to": "+15551231234",
"add": {
"first_word": "Sinch",
"second_word": "JOIN"
},
"remove": {
"first_word": "LEAVE"
}
}
}Example response
{
"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"
}
}
}