---
title: "Update a messaging list. Roles: admin."
method: PUT
path: "/api/messaging-lists/{messagingListId}"
tags: ["Messaging"]
---

# Update a messaging list. Roles: admin.

`PUT /api/messaging-lists/{messagingListId}`

## Path parameters

- `messagingListId` integer, required

## Request body

- MessagingListUpdateRequest
  - `membershipId` integer, required
  - `name` string, required
  - `prompt` string, required
  - `description` string
  - `optOut` boolean, required
  - `active` boolean, required
  - `emailAllowed` boolean, required
  - `pushAllowed` boolean, required
  - `smsAllowed` boolean, required

## Response `200`

OK

- MessagingListResponse
  - `success` boolean
  - `error` string
  - `messagingList` MessagingListFull
    - `audit` Audit
      - `createdTime` string, date-time
      - `modifiedTime` string, date-time
      - `modifiedBy` string
    - `alternateLocales` object
      - `empty` boolean
    - `messagingListId` integer
    - `membershipId` integer
    - `name` string
    - `prompt` string
    - `description` string
    - `optOut` boolean
    - `active` boolean
    - `emailAllowed` boolean
    - `pushAllowed` boolean
    - `smsAllowed` boolean
    - `groupDescendantsIncluded` boolean
    - `groupType` GroupTypeCore
      - `audit` Audit
        - `createdTime` string, date-time
        - `modifiedTime` string, date-time
        - `modifiedBy` string
      - `groupTypeId` integer
      - `membershipId` integer
      - `name` string
      - `namePlural` string
      - `description` string
      - `properties` GroupTypeProperties
        - `announcementsHtml` string
        - `chatEnabled` boolean
        - `chatDefaultEnabled` boolean
        - `contactSharingDefaultEnabled` boolean
        - `postsEnabled` boolean
        - `postsDefaultEnabled` boolean
      - `root` boolean
      - `external` boolean
      - `isPrivate` boolean
    - `group` GroupCore
      - `audit` Audit
        - `createdTime` string, date-time
        - `modifiedTime` string, date-time
        - `modifiedBy` string
      - `groupId` integer
      - `groupType` GroupTypeCore
        - `audit` Audit
          - `createdTime` string, date-time
          - `modifiedTime` string, date-time
          - `modifiedBy` string
        - `groupTypeId` integer
        - `membershipId` integer
        - `name` string
        - `namePlural` string
        - `description` string
        - `properties` GroupTypeProperties
          - `announcementsHtml` string
          - `chatEnabled` boolean
          - `chatDefaultEnabled` boolean
          - `contactSharingDefaultEnabled` boolean
          - `postsEnabled` boolean
          - `postsDefaultEnabled` boolean
        - `root` boolean
        - `external` boolean
        - `isPrivate` boolean
      - `membershipId` integer
      - `name` string
      - `properties` GroupProperties
        - `chatEnabled` boolean
        - `postsEnabled` boolean
      - `nodeActive` boolean
      - `ancestryActive` boolean
      - `active` boolean
      - `root` boolean
      - `external` boolean
      - `externalReferenceId` string
    - `locale` string

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.dev/mobilecoach/apis/untitled-api.md) · [All operations](https://skmtc.dev/mobilecoach/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mobilecoach/untitled-api/revisions/f2568e11c0ab/schema)