SendInvites

Sends an invitation email to selected users and groups.

Request Syntax


POST /spaces/spaceId/invite HTTP/1.1
Content-type: application/json

{
   "accessorIds": [ "string" ],
   "body": "string",
   "title": "string"
}

The request uses the following URI parameters.

The ID of the private re:Post.

Required: Yes

The request accepts the following data in JSON format.

The array of identifiers for the users and groups.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

Required: Yes

The body of the invite.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 600.

Required: Yes

The title of the invite.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Required: Yes


HTTP/1.1 200

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400