POST /api/users/invitations

Allows a registered platform user to invite one or more additional users to join the platform. An email invitation is sent to each invited user.

Note: This operation first checks that the platform settings allow users to invite other users to the platform. If the setting is disabled, the operation will fail with an HTTP 401 error. To check platform settings, use the GET /api/businesses/{BusinessID}/settings operation with the optional IncludeSecuritySettings parameter: {protocol}://{hostname}/api/businesses/{BusinessID}/settings?IncludeSecuritySettings=true.

Authorization Roles/Permissions: User (logged in)

This topic includes the following sections:

HTTP Method

POST

Back to top

URL

https://{hostname}/api/users/invitations

Back to top

Sample Request

The example below shows an invitation to one user to join the platform.

Request URL

https://{hostname}/api/users/invitations

Sample request headers

POST http://{hostname}/api/users/invitations HTTP/1.0
Host: {hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

{
  "EmailAddresses":[
    "jane.mead@acmepaymentscorp.com"
  ],
  "Message":"You should join this awesome app management platform."
}

Back to top

Request Headers

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

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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
UserInviteRequest Body UserInviteRequest Required Contains information about an invitation to a user group such as an app team or API Scope Group.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the email address of the user invited to the platform.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Expires: Thu, 16 Apr 2015 20:09:48 GMT

Sample response body: application/json

[ "jane.mead@acmepaymentscorp.com" ]

Back to top

Response Headers

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

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Back to top

Response Body

Name Type Description
EmailAddresses string[ ] One or more email addresses of individuals that are being invited, separated by commas.

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 if the ability for a registered platform user to invite another user is disabled in the platform settings.

404 The resource could not be found. For example, you might get this if you include an invalid APIVersionID.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics