Audiences

Update an audience. Roles: admin.

Changed on
put/api/audiences/{audienceId}

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/audiences/{audienceId}
  • Auth
    AuthToken (a scheme the document does not define)

Path parameters

audienceIdinteger required

Request body

membershipIdinteger required
namestring required
criterionOperator'AND' | 'OR' | 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN_OR_EQUALS' | 'LESS_THAN_OR_EQUALS' required
criterionValuestring
certIdinteger
questionIdinteger
groupIdinteger
groupTypeIdinteger
groupRoleIdinteger
groupDescendantsIncludedboolean
idpPluginIdinteger
courseContentIdinteger

Response

OK

successboolean
errorstring

Changes

  • 6e5d224eed9bRevision changes
    • warning

      added the new AGE enum value to the /// response property for the response status

    • warning

      added the new AGE enum value to the / response property for the response status

    • warning

      added the new GREATER_THAN_OR_EQUALS enum value to the /// response property for the response status

    • warning

      added the new GREATER_THAN_OR_EQUALS enum value to the / response property for the response status

    • warning

      added the new LESS_THAN_OR_EQUALS enum value to the /// response property for the response status

    • warning

      added the new LESS_THAN_OR_EQUALS enum value to the / response property for the response status

    • info

      added the new GREATER_THAN_OR_EQUALS enum value to the request property

    • info

      added the new LESS_THAN_OR_EQUALS enum value to the request property

  • 887e7398ca4aRevision changes
    • info

      added the optional property // to the response with the status