POST /api/apps/{AppID}/members

Adds a new member to the team for the specified app.

Settings: This operation checks whether the setting that allows app team members to invite members who are not already platform users is turned on. If the setting (InviteUnregisteredUsers) is turned off, the operation will fail. To check this setting, run the GET /api/businesses/{BusinessID}/usersettings operation.

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

POST

Back to top

URL

https://{hostname}/api/apps/{AppID}/members

Back to top

Sample Request

The example below shows an invitation to a user who is not already a platform member.

Sample request URL

https://{hostname}/api/apps/app10021.acmepaymentscorp/members

Sample request headers

POST /api/apps/app10019.acmepaymentscorp/members HTTP/1.1
Host:{hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample POST data

{
  "Email":"newteammember01@acmepaymentscorp.com"
}

Back to top

Request Headers

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

Header Description
Accept text/plain
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

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.
MembershipRequest Body MembershipRequest Required Contains information about an invitation sent out to invite a new user to the group. Only the email address is sent.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the ID for the membership request in plain text.

Back to top

Sample Response

The sample response below shows a successful outcome. The MembershipRequestID is returned in the response.

Sample response headers

HTTP/1.1 200 OK
Date: Tue, 24 Jul 2012 14:39:09 GMT
Content-Type: text/plain

Sample response body

group_member_req10023.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
Group Membership Request ID string The ID of the first request submitted. GroupMembershipRequest is a Board item, so the ID returned is a specific class of BoardItemID.

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