---
schema_version: "1"
id: 92589fbf86579743e6bef42be4835b88b7af5d00759d1fbc85a7a3d111499a07
title: ConnectApi.Invitation
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_output_invite.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_invite.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 0879a04f4caf73e798aed87a93e85cb7de699e0948b75a5363dd44adf991ac01
description: An invitation.
---
# ConnectApi.Invitation

An invitation.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d1025106e27">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d1025106e29">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d1025106e31">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d1025106e33">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d1025106e27" data-title="Property Name"><samp class="codeph apex_code">email</samp></td>
              <td class="entry" headers="d1025106e29" data-title="Type">String</td>
              <td class="entry" headers="d1025106e31" data-title="Description"><span class="ph" id="email"><a name="email"><!-- --></a>Email address of the user.</span></td>
              <td class="entry" headers="d1025106e33" data-title="Available Version">39.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d1025106e27" data-title="Property Name"><samp class="codeph apex_code">status</samp></td>
              <td class="entry" headers="d1025106e29" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/connectAPI_enums.htm#GroupViralInvitationStatusEnum"><samp class="codeph apex_code"><samp class="codeph apex_code">ConnectApi.​GroupViral​InvitationsStatus</samp></samp></a></td>
              <td class="entry" headers="d1025106e31" data-title="Description">
                <span class="ph" id="status"><a name="status"><!-- --></a>Specifies the status of an invitation to join a group. Values are:</span>
                <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph apex_code">ActedUponUser</samp>—The user was added to the group. An email was sent asking the user to visit the group.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">Invited</samp>—An email was sent asking the user to sign up for the org.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">MaxedOutUsers</samp>—The group has the maximum allowed members.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">MultipleError</samp>—The user wasn’t invited due to multiple errors.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">NoActionNeededUser</samp>—The user is already a member of the group.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">NotVisibleToExternalInviter</samp>—The user is not accessible to the user sending the invitation.
                  </li>
                  <li class="li">
                    <samp class="codeph apex_code">Unhandled</samp>—The user couldn’t be added to the group for an unknown reason.
                  </li>
                </ul>
              </td>
              <td class="entry" headers="d1025106e33" data-title="Available Version">39.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d1025106e27" data-title="Property Name"><samp class="codeph apex_code">userId</samp></td>
              <td class="entry" headers="d1025106e29" data-title="Type">String</td>
              <td class="entry" headers="d1025106e31" data-title="Description"><span class="ph" id="userId"><a name="userId"><!-- --></a>ID of the user.</span></td>
              <td class="entry" headers="d1025106e33" data-title="Available Version">39.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [ConnectApi.Invitations](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_invite_collection.htm "A collection of invitations.")