MOmobilecoach
Audiences

Create an audience. Roles: admin.

Changed on
post/api/audiences

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
  • Auth
    AuthToken (a scheme the document does not define)

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
criterionType'AGE' | 'COMPOUND' | 'COURSE' | 'GROUP' | 'IDENTITY_PROVIDER' | 'PROFILE_QUESTION' | 'PROGRAM' required

Response

OK

successboolean
errorstring

Changes

  • df463b248fcbRevision changes
    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

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

    • info

      removed the VIEW_EDUCATION enum value from the /// response property for the response status

  • 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 AGE enum value to the request property

    • 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