Network Invite

CUSTOM-ENDPOINT

POST https://api.speakap.io/networks/:eid/invite

CUSTOM-AUTHORIZATION

Permissions: invite_users

CUSTOM-REQUEST

URI: /networks/{networkEID}/invite
Method: POST
Accept: application/vnd.speakap.api-v2024.3.2+json+hal
Content-Type: application/x-www-form-urlencoded
Authentication: OAuth 2.0

Parameters

Name	Type	Description
networkEID	EID	Network EID

Request body

Name	Type	Description
resend	boolean	Whether or not to resend the invitations for already invited but not yet activated members. Available for Speakap frontend only
message	string	Add a personal message to the sent invites, used to personalize invites. Available for Speakap frontend only.
invitees	array	List of users to invite. (min. 1, max. 1000)
invitees[ i ].name	string	Optional name, will be used in the invite email and set for the new user.
invitees[ i ].email	string	Email address

Examples

{
   "resend": true,
   "invitees" : [
        { "name": "John Doe", "email": "johndoe@gmail.com" },
        { "name": "Alan Smithee", "email": "smithee@hotmail" },
        { "name": "Jane Doe", "email": "jane@thedoes.com" }
   ]
}

Response

{
    "ETC": "2014-01-29T14:17:01.358+01:00",
    "status": "Network invitations scheduled",
    "data": {
        "johndoe@gmail.com": {
            "status": "sent",
            "EID": "ABCDEF0123456789"
        },
        "smithee@hotmail.com": {
            "status": "invalid",
        },
        "jane@thedoes.com": {
            "status": "member",
            "EID": "1234567890ABCDEF"
        }
    }
}

Response

Invite status:

For each email address, as provided in the 'invitees' list a status and an optional user profile EID are returned. In case of an invalid email address the EID is missing, for all other statuses it will be returned.

Value	Description
sent	Invitee is (scheduled to be) added to the network, and will get an invite.
resend	Invitation is (scheduled to be) resend to the invitee
invitee	There's an existing but not yet activated account for this invitee on the current network.
member	There's an existing, activated account for this invitee on the current network.
invalid	Invalid email address

Status	Data
200	Invitations sent: returns a Feedback object
202	Accepted invitations: returns a Feedback object
400	Invalid data: returns an Error object
403	Unauthorized: returns an Error object