POST /api/groups/{GroupID}/members

Invites a new member to the specified group.

Settings: This operation checks whether the setting that allows group 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. For example, a group leader can perform this action.

Workflow: A default workflow is in effect for new group membership objects, unless a custom workflow is specified. By default, when a new group membership object is created, the API invokes the default initial action, @Invite, to start the workflow. This places the new group member in a Pending state. If a custom workflow is used, the custom workflow definition could choose which state the group membership will be placed in. For example, if you wanted to skip the acceptance of the group membership invitation by the invited user, you could develop and implement a custom workflow to skip the Pending state and put the new group membership directly into the Accepted state. For more information on workflow, see Executing Workflow Actions.

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/groups/{GroupID}/members

Back to top

Sample Request

The example below shows a request to add the specified user to the team.

Request URL

https://{hostname}/api/groups/group19212.acmepaymentscorp/members

Sample request headers

POST /api/groups/group19212.acmepaymentscorp/members HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Email":"hpawnitoff@acmepaymentscorp.com",
  "Role":"com.soa.group.membership.role.member",
  "Message":"Please join the team!"
}

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 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. 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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
GroupID Path string Required The unique ID for a specific group.
MembershipRequest Body MembershipRequest Required Contains information about an invitation sent out to invite a new user to the group. Email and Message are required.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the MembershipRequestID for the request.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Date: Fri, 14 Jun 2013 16:28:56 GMT

Sample response body

group_member_req24560.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
MembershipRequestID String The unique ID for a specific user's membership in a specific group.

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. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics