neko/webpage/docs/api/members-bulk-update.api.mdx
2025-03-22 17:52:56 +01:00

71 lines
No EOL
5.7 KiB
Text

---
id: members-bulk-update
title: "Bulk Update Members"
description: "Update the profiles of multiple members in bulk."
sidebar_label: "Bulk Update Members"
hide_title: true
hide_table_of_contents: true
api: eJzVWFtv27gS/isDFlicI8hOtt0nv6WpFxv0ijg9+5AGAS2NJdYUqXKouD6B//vBDCVbcdJFcbIvm5fIvHxz4cw3Q96rqCtSs2vVYLPEQOomVyVSEUwbjXdqpj63pY4IsUZog18ZiwR+BU1no2ktQr8RjINlZ9dTlSvfYtC8/aJUswH5dWfXCUvlKiC13hGSmt2rl6e/8b+HYt/3sJ1sKYG6okCiVWftdqp2ufrt9NfHu65qhIDfOqQo/01Ago4wgO5ijS6aQhRjLQvvIrrIILptbT9z8pUY6V5RUWOj+StuW1Qz5ZdfsYgqV21gA6NJ2jdIpCscLaQYjKvUsSPfYNTGYgkYgg/Q75uq3S5X0UTLW+c89b5H3O12Yuerp+0kDHcYoHMlBorel3JGvfU5LDt2waojJIhe7PfB/BfBxH+U9U/EhljfYmFWBksISL4LBcJGEzgfYeU7V/5jbNxxNsiZvfblloX8TWqbkkaLdAh6q3JlIjb02JTdsS3sY2soSq5LLsLFG4mkJQ5JKXnYkwJDfp88wSZ/raTTzU84lpXhlawMB3mCF/GGbnXZGDcCWXpvUbtHKBeuZF8igRnDgCHQDgRFIAvtbq2vnoVZaAfWVzCCLLxz7ILngfYoe9SNjkX9TEzB2CPWnp6rJEPs8ajWAW8bLI1+JqwggSDt0bWUhdvCmnbpdSifKSLByegeUmQRupJujdNFNHd4W3SBfHiGMMGDAQ8S3sFniMey6LnOQzwWRymBbVcZR08Rii5Lw9DafhplbQwdHks+26+EhAeEMRpX0UP6S2X9U88ZT+Y5boZGA4xb+dAI/cHKh5FJT8KOWow9r5qAZVJ5l6sGY+25J2k5xnPV6lirmTrRrTnpcW+5iTnphkYlFVnmtOMi9M4X2vZFWOWqC1bNVB1jOzs5sTzHSTB7dXp6qnY3DFR0wcStIL1GHTCcdSz9+maX36tz79cGxyNXfo1uPzBCWDD/J/Yc7zowfWveolA9q1nIEpX3TKs+zN9+vF3MF4uLjx8e+f/sQZMEHRlXgQZCIv6dsCRoxhbsJbP17DNRkMNUFv2slAQJke0WGSMP/MC4bx2G7cE22fqz4mQxtJoIS9AEGgQNWh10g1HKyy5XXHUvD/V5/l03bap2Ul+vh5J186AS9grty9mhSqXkGZWYw8C+QByGenY/DCRyPvx+QK6H4cesmOZ+wGIjvCeJJ80fiEKyi5NTTqbPwQ+49nD26ULlilMmOf/V9HR6+uhIZKl0pn/i8vLqHLQr+XPhizVGWCKZEgku54srRuSuow3+zpTc32o7iaZB4J8eKAbUjXFVDsZFDAPBeWv10qdrSC74ARsfEUqkdfQtrDpXJMYycTv94r64Fy9ewLkPCFdY1M7z+SDxxASy7D8ibTFIA8+9d9I+y744gAmIVRbvMOgKCbJsmBbu2iueg/WbidURXbHNoTZVPfnWiRq9Tayt7kozsm6aRLzFrZynLGl8Rwh4hy4ScGWMQTtqTOT7kujHfEncN/Vu7iNsoFNC3Vgud3vPeTcdDL5kfa/Y0QtTsZc4a1wJ575pOjdk0+CGdHKDJ8T0YYj7q46TTEQewIwb1PoXTqtpvqcZpKiX1lDdoIs5XJzPuYCVRu6h+L2otavw31OAJOydnHet4wEh0Telc1/3PjtJ/lppa5e6WIvHau1KO3hrr/PBB0MAsurzOwzbWLPqc0t4sPWIYH6BRa/Ge+10hWxFlsEEFkzg+NR1VPQclBed+MgHA7Ps0vtG1nzmvUew5wF1lARofGlWW/nkxXyPCN6Ks5PQvrnxELxvaCTgTZ8U52kLCfBZ+bUjRgYqAqL0nitTdSmpKIeGFeH59Y/CcjoIWGwpYgN/oLaxhl/gPcZgiiTnkr/xTgSlZXVaVtRYrElA908K2oJxZKo6Jv1T2v7hN3AR4cxa+NOHNcGVrzDWGHjBr9NxLqYjp9RGHhJMjjjLjugl7/OQVSh11Fk2/eJeTo8CHB11/NCgIctapj6KErlLU5qAPctk2XH6jWhgnIHJrlfTUfxl2cB/TCsr43BSBW0c7g85y1IMj865Zz0OnQcHJ9H9O99PmetKubNSzm8FUn2FNPiZRQK/9EXHkTbsVLmypkBH4zJ31uqiRngpTP+gEdpsNlMts1MfqpN+K528uziff1jMJy+np9M6NlZKLTdljXYjYG7ooH+A6h+EjmvJ6Lr8/zxV9W1FxO/xpLXaOG48xIT7vju85p5D5WrcH7KZqUO8yVUqydfq/n6pCT8Hu9vxcOpNZtc3ubrTweglF0lu7VSNusQgjeAat2qmzpMFkytWhpfbLvU6R5d/bgvTjrOiwDb+5dqbUbv76ePiSuVq2T8wNL7kPUFv+ClOb9RMyaudRB8vkLF7ZbWrOnn5UAmT//4HpcwODQ==
sidebar_class_name: "post api-method"
info_path: docs/v3/api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Bulk Update Members"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/members_bulk/update"}
context={"endpoint"}
>
</MethodEndpoint>
Update the profiles of multiple members in bulk.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"The list of member IDs to be updated."},"profile":{"x-tags":["members"],"type":"object","properties":{"name":{"type":"string","description":"The name of the member."},"is_admin":{"type":"boolean","description":"Indicates if the member is an admin."},"can_login":{"type":"boolean","description":"Indicates if the member can log in."},"can_connect":{"type":"boolean","description":"Indicates if the member can connect."},"can_watch":{"type":"boolean","description":"Indicates if the member can watch."},"can_host":{"type":"boolean","description":"Indicates if the member can host."},"can_share_media":{"type":"boolean","description":"Indicates if the member can share media."},"can_access_clipboard":{"type":"boolean","description":"Indicates if the member can access the clipboard."},"sends_inactive_cursor":{"type":"boolean","description":"Indicates if the member sends inactive cursor."},"can_see_inactive_cursors":{"type":"boolean","description":"Indicates if the member can see inactive cursors."},"plugins":{"type":"object","additionalProperties":true,"description":"Additional plugin settings."}},"title":"MemberProfile","description":"The new profile information for the members."}},"title":"MemberBulkUpdate"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"Members updated successfully."},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"404":{"description":"The specified resource was not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
</StatusCodes>