Adds users to an audience's members list.

Prev Next
Post
/audiences/{audienceId}/members

Takes in an audience id/reference and an array of user emails/refs/ids which already exist on the Thrive system.

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
Array of string

An array of user emails/refs/ids which already exist on the Thrive system.

Min items1
Max items100
Example[ "test.user@thrivelearning.com", "TestUser1" ]
string
Responses
200

An object containing the count of successfully processed entities and an array of the entity identifiers. See the Audience Workflow Documentation for code examples on handling successful responses.

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. This response occurs when some operations succeeded while others failed. See the Audience Workflow Documentation for detailed examples on handling partial success responses.

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