---
title: "Update an audience. Roles: admin."
method: PUT
path: "/api/audiences/{audienceId}"
tags: ["Audiences"]
---

# Update an audience. Roles: admin.

`PUT /api/audiences/{audienceId}`

## Path parameters

- `audienceId` integer, required

## Request body

- AudienceUpdateRequest
  - `membershipId` integer, required
  - `name` string, required
  - `criterionOperator` 'AND' | 'OR' | 'EQUALS' | 'NOT_EQUALS', required
  - `criterionValue` string
  - `certId` integer
  - `questionId` integer
  - `groupId` integer
  - `groupTypeId` integer
  - `groupRoleId` integer
  - `groupDescendantsIncluded` boolean
  - `idpPluginId` integer
  - `courseContentId` integer
  - `children` AudienceIdRequest[]
    - `audienceId` integer, required

## Response `200`

OK

- AudienceResponseAudienceFull
  - `success` boolean
  - `error` string
  - `audience` AudienceFull
    - `audit` Audit
      - `createdTime` string, date-time
      - `modifiedTime` string, date-time
      - `modifiedBy` string
    - `audienceId` integer
    - `membershipId` integer
    - `name` string
    - `criterionType` 'COMPOUND' | 'COURSE' | 'GROUP' | 'IDENTITY_PROVIDER' | 'PROFILE_QUESTION' | 'PROGRAM'
    - `criterionOperator` 'AND' | 'OR' | 'EQUALS' | 'NOT_EQUALS'
    - `criterionValue` string
    - `invalidTime` string, date-time
    - `groupDescendantsIncluded` boolean
    - `idpPluginId` integer
    - `cert` CertCore
      - `audit` Audit
        - `createdTime` string, date-time
        - `modifiedTime` string, date-time
        - `modifiedBy` string
      - `alternateLocales` object
        - `empty` boolean
      - `certId` integer
      - `membershipId` integer
      - `typeCode` 'CERTIFICATION' | 'CHALLENGE' | 'MEMBERSHIP' | 'PASS'
      - `name` string
      - `shortDescription` string
      - `description` string
      - `external` boolean
      - `required` boolean
      - `audienceId` integer
      - `externalPluginId` integer
      - `externalId` string
      - `externalReferenceId` string
      - `allowAdminEnroll` boolean
      - `allowSelfEnroll` boolean
      - `autoEnrollEnabled` boolean
      - `autoRenewalEnabled` boolean
      - `isOpen` boolean
      - `unlisted` boolean
      - `credits` number
      - `pointsRequired` number, float
      - `renewalPointsRequired` number, float
      - `completionStrategy` 'ALL_PREREQ_COMPLETE' | 'ANY_PREREQ_COMPLETE' | 'EARNED_REQUIRED_POINTS'
      - `renewalStrategy` 'ALL_PREREQ_COMPLETE' | 'ANY_PREREQ_COMPLETE' | 'EARNED_REQUIRED_POINTS'
      - `certificateUuid` string, uuid
      - `certificatesEnabled` boolean
      - `enrollmentNotificationsEnabled` boolean
      - `completionNotificationsEnabled` boolean
      - `imageUuid` string, uuid
      - `openDate` string, date
      - `closeDate` string, date
      - `termIntervalCode` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
      - `termIntervalCount` integer
      - `termStartCode` 'EARN' | 'ENROLL' | 'FIRST_EARN' | 'FIRST_ENROLL' | 'ANCHOR'
      - `expireReminderDays` integer
      - `earlyRenewalDays` integer
      - `renewalGracePeriodDays` integer
      - `renewalAnchorDate` string, date
      - `emailCompletionBody` string
      - `tier` integer
      - `benefitTypeCode` 'PHYSICAL' | 'VIRTUAL' | 'HYBRID'
      - `programCategory` ProgramCategoryCore
        - `audit` Audit
          - `createdTime` string, date-time
          - `modifiedTime` string, date-time
          - `modifiedBy` string
        - `alternateLocales` object
          - `empty` boolean
        - `programCategoryId` integer
        - `membershipId` integer
        - `typeCode` 'CERTIFICATION' | 'CHALLENGE' | 'MEMBERSHIP' | 'PASS'
        - `name` string
        - `description` string
        - `required` boolean
        - `tierBehaviorCode` 'NONE' | 'REPLACE_ON_ENROLL' | 'REPLACE_ON_COMPLETION'
        - `downgradePolicyCode` 'NEVER' | 'DURING_RENEWAL' | 'ALWAYS_NO_REFUND' | 'ALWAYS_REFUND' | 'ALWAYS_REFUND_LESS_FEES'
        - `locale` string
      - `memberCert` MemberCertCore
        - `audit` Audit
          - `createdTime` string, date-time
          - `modifiedTime` string, date-time
          - `modifiedBy` string
        - `token` string, uuid
        - `enrollDate` string, date
        - `firstEnrollDate` string, date
        - `startDate` string, date
        - `earnDate` string, date
        - `firstEarnDate` string, date
        - `renewalEligibleDate` string, date
        - `expireDate` string, date
        - `failDate` string, date
        - `endDate` string, date
        - `creditsEarned` number
        - `pointsEarned` number, float
        - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'EXPIRED'
        - `externalEnrollmentId` string
        - `renewable` boolean
        - `expiresSoon` boolean
      - `locale` string
    - `course` CourseCore
      - `audit` Audit
        - `createdTime` string, date-time
        - `modifiedTime` string, date-time
        - `modifiedBy` string
      - `alternateLocales` object
        - `empty` boolean
      - `contentId` integer
      - `contentType` string
      - `membershipId` integer
      - `detail` string
      - `previewing` boolean
      - `subTitle` string
      - `thumbnailImageUuid` string, uuid
      - `title` string
      - `keywords` string
      - `body` string
      - `properties` object
      - `externalPluginId` integer
      - `externalId` string
      - `externalReferenceId` string
      - `certificateUuid` string, uuid
      - `credits` number
      - `courseEmailCompletionBody` string
      - `termIntervalCode` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
      - `termIntervalCount` integer
      - `earlyRenewalDays` integer
      - `locale` string
      - `certificatesEnabled` boolean
      - `allowAdminEnroll` boolean
      - `allowSelfEnroll` boolean
      - `allowSelfEnrollReset` boolean
      - `enrollmentNotificationsEnabled` boolean
      - `completionNotificationsEnabled` boolean
      - `creditsRepeatable` boolean
      - `isPublished` boolean
    - `question` QuestionCore
      - `audit` Audit
        - `createdTime` string, date-time
        - `modifiedTime` string, date-time
        - `modifiedBy` string
      - `alternateLocales` object
        - `empty` boolean
      - `profileQuestionId` integer
      - `membershipId` integer
      - `contextKey` 'ACTIVITY' | 'EVAL' | 'EVENT' | 'PROFILE_SECTION' | 'SELF_REPORT'
      - `profileSectionId` integer
      - `evalSectionId` integer
      - `contentId` integer
      - `eventId` integer
      - `name` string
      - `profileQuestionType` string
      - `prompt` string
      - `helpText` string
      - `seq` integer
      - `optional` boolean
      - `disabled` boolean
      - `adminOnly` boolean
      - `properties` object
      - `responderType` 'PRIMARY' | 'DEPENDENT' | 'ALL'
      - `responderCommentMode` 'DISABLED' | 'OPTIONAL' | 'REQUIRED'
      - `responseImagesMode` 'DISABLED' | 'OPTIONAL' | 'REQUIRED'
      - `scoringMode` 'BEST_MATCH' | 'EXACT_MATCH' | 'PARTIAL_MATCH_STRICT' | 'PARTIAL_MATCH_PENALIZED'
      - `externalReferenceId` string
      - `locale` string
      - `isDeferred` boolean
      - `isExternal` 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
    - `groupRole` GroupRoleCore
      - `audit` Audit
        - `createdTime` string, date-time
        - `modifiedTime` string, date-time
        - `modifiedBy` string
      - `groupRoleId` integer
      - `name` string
      - `namePlural` string
      - `external` boolean
      - `selfRegistrationAccessCode` 'CLOSED' | 'GROUP_MEMBERS' | 'OPEN'
      - `dependentRegistrationAccessCode` 'CLOSED' | 'GROUP_MEMBERS' | 'OPEN'
      - `invitationsAllowed` boolean
      - `activitySubmissionNotificationsEnabled` boolean
      - `permissions` string[]
    - `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
    - `children` AudienceCore[]
      - `audit` Audit
        - `createdTime` string, date-time
        - `modifiedTime` string, date-time
        - `modifiedBy` string
      - `audienceId` integer
      - `membershipId` integer
      - `name` string
      - `criterionType` 'COMPOUND' | 'COURSE' | 'GROUP' | 'IDENTITY_PROVIDER' | 'PROFILE_QUESTION' | 'PROGRAM'
      - `criterionOperator` 'AND' | 'OR' | 'EQUALS' | 'NOT_EQUALS'
      - `criterionValue` string
      - `invalidTime` string, date-time
      - `groupDescendantsIncluded` boolean
      - `idpPluginId` integer
    - `memberCount` integer
    - `changesPending` boolean

## 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)