-
Notifications
You must be signed in to change notification settings - Fork 8
PeopleBulkProcess
michael.rybintsev edited this page Aug 8, 2019
·
2 revisions
This resource enables operations to be performed against multiple resources in a single request.
Operation |
---|
Bulk Delete |
This resource supports bulk deleting members from one company. To bulk delete, issue a POST request to the bulk-delete endpoint, with an entity body that contains a list of members. Each member should be referenced with their self-link and a rel of 'member'.
The caller must have company manager permissions.
Any already deleted members in the request will remain unchanged by this operation, and will be treated as a successful deletion.
The link for this API is advertised in the company response.
Bulk delete members 123 and 456 from company 42
POST .../people/companies/42/bulkdelete HTTP/1.1
Content-Type: application/vnd.huddle.data+xml
Authorization: OAuth2 frootymcnooty/vonbootycherooty
<bulkDelete>
<link rel="member" href=".../people/companies/42/members/123" />
<link rel="member" href=".../people/companies/42/members/456" />
</bulkDelete>
If successful the method returns a 204 No Content code.
HTTP/1.1 204 No Content
POST .../people/companies/42/bulkdelete HTTP/1.1
Content-Type: application/vnd.huddle.data+json
Authorization: OAuth2 frootymcnooty/vonbootycherooty
{
"links": [{
"rel": "member",
"href": ".../people/companies/42/members/123"
},
{
"rel": "member",
"href": ".../people/companies/42/members/456"
}]
}
If successful the method returns a 204 No Content code.
HTTP/1.1 204 No Content
Case | Response |
---|---|
User does not have company manager permissions | 403 Forbidden |
Company does not exist | 404 Not Found |
Member does not exist | 400 Bad Request |
Member is not in that company | 400 Bad Request |
- Basic concepts
-
Resources
- Actor
- Approvals
- BulkProcess
- Calendar
- Membership
- Company
- Document
- Document library settings
- Folder
- Paged Folder
- Pins
- Integrations
- Form
- Friends
- Invitation
- Link
- Document Lock
- Folder Lock
- Localisation
- MemberAutocomplete
- Notifications
- Offline item
- PeopleBulkProcess
- Permissions
- Presence
- PublishedDocuments
- Recents
- Recommendations
- Recycle Bin
- Search
- Share
- Tasks (Todos), File Requests, Approvals
- Tasks on Documents
- Actions
- UserApprovals
- User
- VersionHistory
- Workspace
- Workspaces
- SamlPartners
- Logout
- Impersonation
- Administration
- WebHooks