Skip to content
Home/
REST API Reference
/
/
Remove an admin

Remove an admin

Request

You can remove a single admin (teammate) from your workspace. Requires the remove_admins OAuth scope.

This removes the admin's access to the workspace and reassigns their work — auto-messages, ownership, article authorship, and conversation replies — to the admins named by the reassign_* parameters.

Security
bearerAuth
Query
admin_idintegerrequired

The unique identifier of the admin to remove.

Example:admin_id=123
reassign_messages_admin_idintegerrequired

The unique identifier of a human admin to reassign the removed admin's auto-message ownership to.

Example:reassign_messages_admin_id=456
reassign_owner_admin_idintegerrequired

The unique identifier of a human admin to reassign the removed admin's ownership (of users and leads) to.

Example:reassign_owner_admin_id=456
reassign_articles_author_idintegerrequired

The unique identifier of a human admin to reassign the removed admin's article authorship to.

Example:reassign_articles_author_id=456
reassign_conversations_admin_idintegerrequired

The unique identifier of a human admin with Inbox access to reassign the removed admin's conversation replies to. Pass 0 to leave conversations unassigned.

Example:reassign_conversations_admin_id=456
reassign_replies_teamsArray of objects

A list of teams and the admin each team's conversation replies should be reassigned to.

Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"Preview"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:Preview
curl -i -X DELETE \
  'https://api.intercom.io/admins/remove?admin_id=123&reassign_messages_admin_id=456&reassign_owner_admin_id=456&reassign_articles_author_id=456&reassign_conversations_admin_id=456&reassign_replies_teams=%5Bobject%20Object%5D' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Successful response

Bodyapplication/json
idstring

The unique identifier of the removed admin.

Example:"123"
objectstring
Value:"admin"
Example:"admin"
removedstring

Whether the admin was removed. Returned as the string "true".

Value:"true"
Example:"true"
Response
{
  "id": "123",
  "object": "admin",
  "removed": "true"
}