Update a team's members

Request

You can replace the set of teammates who belong to a team. Send the full list of teammates the team should end up with — any teammate currently on the team and missing from the list is removed. This makes the endpoint safe to call on a schedule to keep Intercom in step with an external rota or workforce management system, since sending an unchanged list makes no changes at all.

A token that acts on behalf of a teammate carries that teammate's permissions: they must be able to manage teams, and any team or teammate their access is restricted from remains out of reach here.

Security

bearerAuth

Path

idstringrequired

The unique identifier of a given team.

Example:123

Intercom-Versionstring(intercom_version_preview)

Preview Intercom API version. Used for closed beta endpoints or other features under managed availability.

Default:"preview"

Value:"preview"

Example:preview

Bodyapplication/jsonrequired

admin_idsArray of integers, [ 1 .. 1000 ] itemsrequired

The ids of every teammate who should be a member of the team. Must contain at least one id, and no more than 1000.

Example:

admin_priority_levelobject or null(Admin Priority Level)

Admin priority levels for the team

curl -i -X PUT \
  https://api.intercom.io/teams/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: preview' \
  -d '{
    "admin_ids": [
      493881,
      493882
    ]
  }'

Responses

successful

Bodyapplication/json

typestring

Value is always "team"

Example:"team"

idstring

The id of the team

Example:"814865"

namestring

The name of the team

Example:"Example Team"

admin_idsArray of integers

The list of admin IDs that are a part of the team.

Example:

[
  493881
]

admin_priority_levelobject or null(Admin Priority Level)

Admin priority levels for the team

Response

{
  "type": "team",
  "id": "991267902",
  "name": "team 1",
  "admin_ids": [
    493881,
    493882
  ]
}