DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Remove an admin

Example Request & Response

$ curl https://api.intercom.io/admins/remove \
-X DELETE \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json' \
-H 'Content-Type:application/json'

{
  "admin_id": "1234567",
  "reassign_auto_messages_admin_id": "7654321",
  "reassign_owner_admin_id": "7654321",
  "reassign_articles_author_id": "7654321",
  "reassign_conversations_admin_id": "7654321"
}
HTTP/1.1 200 OK
{
  "id": "1234567",
  "object": "admin",
  "removed": "true"
}
Example Errors

HTTP/1.1 404 NOT FOUND
{
  "type": "error.list",
  "request_id": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "admin_not_found",
      "message": "Admin for #{relevant_request_field} not found"
    }
  ]
}
HTTP/1.1 405 METHOD NOT ALLOWED
{
  "type": "error.list",
  "request_id": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "action_forbidden",
      "message": "This method is not allowed for this type of Admin for #{relevant_request_field}"
    }
  ]
}

You can remove a single admin from a workspace.

Request Body Parameters

Parameter

Type

Required

Description

admin_id

String

Yes

The unique identifier for the admin to be deleted.

reassign_auto_messages_admin_id

String

Yes

The unique identifier for the admin who will be assigned the deleted admin's outbound messages.
Must be a human admin.

reassign_owner_admin_id

String

Yes

The unique identifier for the admin who will be assigned as the owner of the deleted admin's accounts (aka. the owner_id of a contact).
Must be a human admin.

reassign_articles_author_id

String

Yes

The unique identifier for the admin who will be assigned as the author of the deleted admin's accounts.
Must be a human admin.

reassign_conversations_admin_id

String

Yes

The unique identifier for the admin who will be assigned the deleted admin's conversations.
The provided admin must either be Unassigned ('0'), or have access to the Inbox product or the call will hard fail.

Response

This will return an object with details on the removed admin.

Attribute

Type

Description

id

String

The unique identifier for the admin which is given by Intercom

object

String

The type of object - admin

removed

Boolean

Whether the admin has been removed from the workspace - true