Add a user to an audience's managers list.

Prev Next
Post
/audiences/{audienceId}/managers

Takes in an audience id/reference as well as a list of users/ permissions to add audience managers.

Security
HTTP
Type basic

To pass the authentication step you will need to provide the following:

Username is the Tenant ID (i.e. eu-west-2_AbcdEfghI) Password is the secret you would have received

Path parameters
audienceId
stringRequired

Filter by audienceId or audience reference.

Example63f57d805d8ecbf46f5b5278
Body parameters
childAudience

Child audience

[
  {
    "userId": "63f8c5361b9c80d3274be7ca",
    "reference": "user123",
    "email": "test@thrivelearning.com",
    "permissions": {
      "audienceManager": {
        "manageContent": true,
        "assignments": true
      },
      "peopleManager": {
        "canViewLearnPage": true,
        "insights": true,
        "manage": true
      }
    }
  }
]
structureAudience

Structure/Parent audience

[
  {
    "userId": "63f8c5361b9c80d3274be7ca",
    "reference": "user123",
    "email": "test@thrivelearning.com",
    "permissions": {
      "administrator": {
        "canAddAudienceManagers": true
      },
      "audienceManager": {
        "manageContent": true,
        "assignments": true
      },
      "peopleManager": {
        "canViewLearnPage": true,
        "insights": true,
        "manage": true
      }
    }
  }
]
Expand All
OneOf
array
array
object

The audience manager object.

reference
string

The user's email or reference in Thrive.

Exampletest.user@thrivelearning.com
permissions
object (ChildAudienceManagerPermissionsStub)

The permissions a child audience manager can be assigned.

audienceManager
object

The audience manager permissions set

manageContent
boolean

Whether the user can share/unshare content for the audience via the UI.

Defaultfalse
Examplefalse
assignments
boolean

Whether the user can create/ edit/ remove assignments for the audience via the UI.

Defaultfalse
Examplefalse
peopleManager
object

The people manager permissions set

canViewLearnPage
boolean

Whether the user can view the learn page of audience members.

Defaultfalse
Examplefalse
insights
boolean

Whether the user can view insights into how the audience is using content and search, along with whether the user can run compliance reports on assignments associated to audience members.

Defaultfalse
Examplefalse
manage
boolean

Whether the user can add/edit goals for audience members.

Defaultfalse
Examplefalse
array
array
object

The structure/ parent audience manager object.

reference
string

The user's email or reference in Thrive.

Exampletest.user@thrivelearning.com
permissions
object (StructureAudienceManagerPermissionsStub)

The permissions a structure/ parent audience manager can be assigned.

audienceManager
object

The audience manager permissions set

manageContent
boolean

Whether the user can share/unshare content for the audience via the UI.

Defaultfalse
Examplefalse
assignments
boolean

Whether the user can create/ edit/ remove assignments for the audience via the UI.

Defaultfalse
Examplefalse
peopleManager
object

The people manager permissions set

canViewLearnPage
boolean

Whether the user can view the learn page of audience members.

Defaultfalse
Examplefalse
insights
boolean

Whether the user can view insights into how the audience is using content and search, along with whether the user can run compliance reports on assignments associated to audience members.

Defaultfalse
Examplefalse
manage
boolean

Whether the user can add/edit goals for audience members.

Defaultfalse
Examplefalse
administrator
object

The administrator permissions set - only available on structures/ parent audiences.

canAddAudienceManagers
boolean

Whether the user can add or edit managers for child audiences - only available on structures/ parent audiences.

Defaultfalse
Examplefalse
Responses
200

An object containing the count of successfully processed entities and an array of the entity identifiers.

Expand All
object

A success response for adding members/managers.

success
object

An object describing the successfully proccessed entities

count
number

The number of entities that have been successfully processed

Example1.0
entities
Array of object
object
reference
string

The reference for the entity.

ExampleTestUser1
207

An object containing the count of successfully/unsuccessfully processed entities and an array of the relevant entity identifiers.

Expand All
object

A partial success response for adding members/managers.

success
object

An object describing the successfully proccessed entities

count
number

The number of entities that have been successfully processed

Example1.0
entities
Array of object
object
reference
string

The reference for the entity.

ExampleTestUser1
failure
object

An object describing the entities that have been unsuccessfully proccessed

count
number

The number of entities that have been unsuccessfully processed

Example1.0
entities
Array of object
object
reason
string

The reason for the failure

ExampleUser does not exist.
reference
string

The reference for the entity.

Exampletest.user@thrivelearning.com
400

Bad Request

object

Bad Request

status
number
Example400.0
error
string
ExampleBad Request
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
401

Unauthorized

object

Unauthorized

status
number
Example401.0
error
string
ExampleUnauthorized
message
string
403

Forbidden

object

Forbidden

status
number
Example403.0
error
string
ExampleForbidden
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
404

Not Found

object

Not found

status
number
Example404.0
error
string
ExampleNot Found
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
409

Conflict

object

Conflict

status
number
Example409.0
error
string
ExampleConflict
message
OneOf
string
string
object
object
422

Unprocessable Content

object

Unprocessable Content

status
number
Example422.0
error
string
ExampleUnprocessable Content
message
string #deprecatedtemplate# #additional-property-template#
OneOf
string
string
object
object
default

Internal Server Error

object

Internal Server Error

status
number
Example500.0
error
string
ExampleInternal Server Error
message
string