Replace an audience for a path session

put

https://app.360learning.com/api/v2/paths/{pathId}/sessions/{sessionId}/audiences

🔑
Required OAuth scope: paths:write.

Replaces the audience in the given path and session with the provided one. Audience not included is removed.

Path Params

pathId

string

required

^[a-fA-F0-9]{24}$

The unique ID of the path.

sessionId

string

required

^[a-fA-F0-9]{24}$

The unique ID of the path session.

Body Params

filters

array

required

length ≤ 3

The list of filters in the audience. The maximum filters array size is 3.

filters*

mode

string

enum

required

The audience builder update mode. Options are:

dynamic: Learners are dynamically enrolled and unenrolled.
dynamicEnrollment: Learners are dynamically enrolled.
dynamicUnenrollment: Learners are dynamically unenrolled.
manual: The audience is manually updated.

Allowed:

Headers

360-api-version

string

enum

required

The version of the API.

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the updated session audience.

400The server cannot or will not process the request due to something that is perceived to be a client error.

401The given access token is either missing, invalid, has expired, or has been revoked.

403The given access token does not have the required OAuth scope to execute the request.

404The server cannot find the requested resource.

429The client has sent too many requests in a short amount of time.