POST

/invitations

http://macie2.{region}.amazonaws.com/invitations

Sends an Amazon Macie membership invitation to one or more accounts.

Access Token Required: API Key

Body Params

messagestring

Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.

accountIdsarrayrequired

An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

disableEmailNotificationboolean

Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient's account when you associated the account with your account. The default value is false.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://macie2.{region}.amazonaws.com/invitations' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}