DELETE /api/apps/{AppID}/members/{UserID}

Removes a member from the team for the specified resource.

Authorization Roles/Permissions: Must have Modify permission for the resource. App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

https://{hostname}/api/apps/{AppID}/members/{UserID}[?Comment={Comment}]

Back to top

Sample Request

In the example shown below, user user10021.acmepaymentscorp is removed from the app team for app10017.acmepaymentscorp with the comment, "Removing inactive members."

Sample request URL

https://{hostname}/api/apps/app16964.acmepaymentscorp/members/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp?Comment=Removing%20Jonathan%20from%20the%20team%20at%20his%20request.

Sample request headers

DELETE /api/apps/app16964.acmepaymentscorp/members/957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp?Comment=Removing%20Jonathan%20from%20the%20team%20at%20his%20request. HTTP/1.1
Host: {hostname}
Accept: */*
Content-Type: application/json
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type Any format (*/*)
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AppID Path string Required The unique ID for a specific app.
UserID Path string Required The unique ID for a specific user. In this case it is the user being removed from the team.
Comment Query string Optional A comment entered by the user removing the team member.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the UserID of the removed team member.

Back to top

Sample Response

In the example below, the user listed in the response body has been removed from the team.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Thu, 30 May 2013 00:10:02 GMT

Sample response body

957482b9-ck7f-0gk5-ae07-9flgok5djtus.acmepaymentscorp

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
UserID string The unique ID for a specific user.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header.
404 The resource could not be found.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics