Set a user's tags

Update the tags assigned to a Data Room participant, identified by email. Two mutually exclusive modes:

Replacement - provide tagIds: the participant ends up with exactly those tags, and an empty list clears all of their tags. Ideal for sync integrations that mirror a source of truth.

Incremental - provide addTagIds and/or removeTagIds: the listed tags are added to / removed from the participant's current set without touching other tags. Adding an already-assigned tag and removing an unassigned tag are no-ops. Ideal when multiple systems each manage their own tags.

Providing both modes, omitting all three fields, or listing the same tag in addTagIds and removeTagIds responds with 400. Empty addTagIds/removeTagIds lists are accepted and simply change nothing.

Tags can be assigned to participants who have been invited but have not yet joined the Data Room. Responds with 404 if no participant with that email exists in the Data Room, and 400 if any referenced tag is not a tag of the Data Room.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The Anduin ID of your Data Room

Body Params
string
required

Email address of the participant

tagIds
array of objects

Replacement mode: the participant ends up with exactly these tags; [] clears all. Mutually exclusive with addTagIds/removeTagIds.

tagIds
addTagIds
array of objects

Incremental mode: tags to add. Already-assigned tags are no-ops.

addTagIds
removeTagIds
array of objects

Incremental mode: tags to remove. Unassigned tags are no-ops.

removeTagIds
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json