RemoveProjectTeamMembers

This method can be used for the following functionality: Remove user(s) from a project team.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

PUT /api/ss/project/:id/team/remove HTTP/1.1
Host: localhost:3000
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Project Id.

Example:

PUT /api/ss/project/620f1707c66ef8821d35ee17/team/remove HTTP/1.1

users (string array)

Usernames, email addresses or userIds for each user you are removing from the project team.

Example:

{   
    "users": [ 
        "[e-mail]", 
        "6132a2db9239f0975f505c4b" 
    ]
}

Example

The following example is a cURL request to remove multiple users from a specified project.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X PUT 'https://localhost:3000/api/ss/project/620f1707c66ef8821d35ee17/team/remove' -H 'Host: localhost:3000' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '
{  
    "users": [ 
        "[e-mail]", 
        "6132a2db9239f0975f505c4b"
    ]
}'

Response

Response contains a results array.

{
  "result": [
    {
      "userId": "6132a2db9239f0975f505c4b",
      "username": "[e-mail]",
      "email": "[e-mail]",
      "status": "Removed"
    }
  ]
}