API ReferenceGet Started with the APIDegreed IntegrationsxAPIAPI ChangelogDiscussions

Delete Users in a Group

delete https://api.betatest.degreed.com/api/v2/groups//relationships/

This endpoint deletes the specified users in a role of an existing group. On a successful delete, it returns a 204 No Content response.

Scope Required

groups:write

🚧

Body Parameters

  • id
    Required. ID of the user that will be removed from the group.
  • type
    Type of object that will be removed as a relationship. Can only be users.

Refer to the example request below.

https://api.betatest.degreed.com/api/v2/groups/<groupId>/relationships/<roleId>
  -H "Content-Type: application/json"
  -H "Authorization: Bearer <access_token>"
  -X DELETE
  -d '{ \
    "data": [ \
    { \
      "id": "64rrL" \
      "type": "users" \
        }, \
    { \
      "id": "8oWW3" \
      "type": "users" \
        } \
    ] \
  }'
Language
Authorization
Bearer
Click Try It! to start a request and see the response here!