Teams Public API
    Teams Members Public API

    Rate this page:

    Teams Members Public API

    Manage the members of a team

    Add a set of membership(s).

    POST /public/teams/v1/org/{orgId}/teams/{teamId}/members/add

    The account IDs specified will be added to the team.

    Request

    Path parameters
    orgId Required

    string

    The ID of the organisation of the team you are adding members to.

    teamId Required

    string

    The ID of the team you are adding members to.

    Body parameters
    members Required

    Array<PublicApiMembership>

    Min items: 1, Max items: 50, Unique items: true

    Example

    1
2
3
4
5
6
7
8
9
10
11
    curl --request POST \
  --url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/{teamId}/members/add' \
  --header 'Accept: */*' \
  --header 'Content-Type: application/json' \
  --data '{
  "members": [
    {
      "accountId": "<string>"
    }
  ]
}'

    Responses

    Team members were added successfully, at least partially. See the 'members' field of the response for any successful additions, and the 'errors' field of the response for any failed additions.

    Content typeValue
    */*

    PublicApiMembershipAddResponse

    Remove a set of membership(s).

    POST /public/teams/v1/org/{orgId}/teams/{teamId}/members/remove

    The account IDs specified will be removed from the team.

    Request

    Path parameters
    orgId Required

    string

    The ID of the organisation of the team you are removing members from.

    teamId Required

    string

    The ID of the team you are removing members from.

    Body parameters
    members Required

    Array<PublicApiMembership>

    Min items: 1, Max items: 50, Unique items: true

    Example

    1
2
3
4
5
6
7
8
9
10
11
    curl --request POST \
  --url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/{teamId}/members/remove' \
  --header 'Accept: */*' \
  --header 'Content-Type: application/json' \
  --data '{
  "members": [
    {
      "accountId": "<string>"
    }
  ]
}'

    Responses

    Team members were removed successfully, at least partially. See the 'errors' field of the response for any failed removals.

    Content typeValue
    */*

    PublicApiMembershipRemoveResponse

    Rate this page: