cURL
curl --request POST \ --url https://api.velt.dev/v2/organizations/usergroups/users/delete \ --header 'Content-Type: application/json' \ --header 'x-velt-api-key: <x-velt-api-key>' \ --header 'x-velt-auth-token: <x-velt-auth-token>' \ --data '{ "data": { "organizationId": "<string>", "organizationUserGroupId": "<string>", "userIds": [ "<string>" ], "deleteAll": true } }'
{ "result": { "status": "success", "message": "Deleted users from group successfully.", "data": { "yourUserId1": { "success": true, "organizationUserGroupId": "yourGroupId", "message": "User deleted from organization user group." } } } }
POST https://api.velt.dev/v2/organizations/usergroups/users/delete
Show properties
{ "data": { "organizationId": "yourOrganizationId", "organizationUserGroupId": "yourGroupId", "userIds": ["yourUserId1"] } }
{ "data": { "organizationId": "yourOrganizationId", "organizationUserGroupId": "yourGroupId", "deleteAll": true } }
{ "error": { "message": "ERROR_MESSAGE", "status": "INVALID_ARGUMENT" } }
Was this page helpful?