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 be logged in. Must have Modify permission for the resource. App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

POST

URL

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

Sample Request

The example below shows inviting a user to a team. In version 2022.1.0 or later, the message is required.

https://{hostname}/api/apps/0cfec000-994d-4339-8dc9-ccd84bbc7eda.acmepaymentscorp/members

Sample request headers

POST /api/apps/0cfec000-994d-4339-8dc9-ccd84bbc7eda.acmepaymentscorp/members
Host:{hostname}
Accept: text/plain
Content-Type: application/json
Cookie: {cookie}
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample POST data

{
  "Message":"Hi Jane. Inviting you to the Puzzle app team as discussed.",
  "Email":"jmead@acmepaymentscorp.com"
}

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
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

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. Valid in version: 2022.1.0 and later: Email and Message values are both required.

Response

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

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: Thu, 15 Jul 2021 14:02:58 GMT
Content-Type: text/plain

Sample response body

group_member_req10083.acmepaymentscorp

Response Headers

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

Header	Description
Content-Type	text/plain

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.

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
400	Bad request: Returned if the client sends a malformed request; for example, invalid parameters or body content. For example, you would get this response if you sent an invalid parameter value in the request URL.
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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics