---
title: "Update a group"
method: POST
path: "/xms/v1/{service_plan_id}/groups/{group_id}"
tags: ["Groups"]
---

# Update a group

`POST /xms/v1/{service_plan_id}/groups/{group_id}`

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:

1. 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.
2. By using the `auto_update` object, your customer can add or remove themselves from groups. 
3. 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.

## Request body

- ApiGroupUpdate
  - `add` string[] — Add a list of phone numbers (MSISDNs) to this group. The phone numbers are a strings within an array and must be in [E.164 format](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537).
  - `remove` string[] — Remove a list of phone numbers (MSISDNs) to this group.The phone numbers are a strings within an array and must be in [E.164 format](https://community.sinch.com/t5/Glossary/E-164/ta-p/7537).
  - `name` string — The name of the group. Omitting `name` from the JSON body will leave the name unchanged. To remove an existing name set, name explicitly to the JSON value `null`.
  - `add_from_group` string — One time copy of all members from the group referenced by the group ID into this group.
  - `remove_from_group` string — Remove all members from this group that are currently in the group referenced by the group ID.
  - `auto_update` ApiGroupAutoUpdate
    - `to` string, E.164, required — Short code or long number addressed in [MO](https://community.sinch.com/t5/Glossary/MO-Mobile-Originated/ta-p/7618). Constraints: Must be valid phone number or short code which has been **provisioned by your account manager**.
    - `add` AddKeyword — Keyword to be sent in MO to add MSISDN to a group
      - `first_word` string, required — Opt-in keyword like "JOIN" if _auto_update.to_ is dedicated long/short number or unique brand keyword like "Sinch" if it is a shared short code.
      - `second_word` string — Opt-in keyword like "JOIN" if _auto_update.to_ is shared short code.
    - `remove` RemoveKeyword — Keyword to be sent in MO to remove MSISDN to a group
      - `first_word` string, required — Opt-out keyword like "LEAVE" if _auto_update.to_ is dedicated long/short number or unique brand keyword like "Sinch" if it is a shared short code.
      - `second_word` string — Opt-out keyword like "LEAVE" if _auto_update.to_ is shared short code.

## Response `200`

A successful response, or an [Error](https://developers.sinch.com/docs/sms/api-reference/status-codes).

- ApiGroup
  - `id` string — The ID used to reference this group.
  - `name` string — Name of group if set.
  - `size` integer — The number of members currently in the group.
  - `created_at` string, date-time — Timestamp for group creation. Format: YYYY-MM-DDThh:mm:ss.SSSZ
  - `modified_at` string, date-time — Timestamp for when the group was last updated. Format: YYYY-MM-DDThh:mm:ss.SSSZ
  - `child_groups` MtGroupId[] — Phone numbers [MSIDNs](https://community.sinch.com/t5/Glossary/MSISDN/ta-p/7628) of child group will be included in this group. If present then this group will be auto populated. Constraints: Elements must be group IDs.
  - `auto_update` ApiGroupAutoUpdate
    - `to` string, E.164, required — Short code or long number addressed in [MO](https://community.sinch.com/t5/Glossary/MO-Mobile-Originated/ta-p/7618). Constraints: Must be valid phone number or short code which has been **provisioned by your account manager**.
    - `add` AddKeyword — Keyword to be sent in MO to add MSISDN to a group
      - `first_word` string, required — Opt-in keyword like "JOIN" if _auto_update.to_ is dedicated long/short number or unique brand keyword like "Sinch" if it is a shared short code.
      - `second_word` string — Opt-in keyword like "JOIN" if _auto_update.to_ is shared short code.
    - `remove` RemoveKeyword — Keyword to be sent in MO to remove MSISDN to a group
      - `first_word` string, required — Opt-out keyword like "LEAVE" if _auto_update.to_ is dedicated long/short number or unique brand keyword like "Sinch" if it is a shared short code.
      - `second_word` string — Opt-out keyword like "LEAVE" if _auto_update.to_ is shared short code.

## Other responses

- `400` — Bad request
- `403` — Forbidden

---

[API](https://skmtc.net/sinch/apis/api-overview-sinch.md) · [All operations](https://skmtc.net/sinch/apis/api-overview-sinch/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/api-overview-sinch/revisions/67cb925f1c81/schema)