API:people/invite

From wiki.groundcrew.us

Invites people to join your Groundcrew squad as agents and optionally as organizers. Invitees will receive an email invitation containing a confirmation link, and will not become full members until they follow that link. They will also need to provide and confirm a phone number and a provide a location before they show up on the map.

Contents 1 URL 2 HTTP Method(s) 3 Parameters 4 Example 5 Email Forms 5.1 Default email to agents

[edit] URL

 http://wwww.groundcrew.us/api/squad/{squad_id}/people/invite

[edit] HTTP Method(s)

POST

[edit] Parameters

Required	Name	Type	Description
required	api_key	string	The authentication key associated with an organization.
	emails	string	A string-delimited list of email addresses to which invitations will be sent.
optional	groups	string	A comma-delimited list of groups to assign, which is currently limited to organizers. All people are added to the default agents group, regardless of this parameter.
	reply_to	string	The reply-to email address used in the email invitations. Defaults to do-not-reply@citizenlogistics.com.
	msg	string	The body of the email message to be sent in the invitations. For default values, see Email Form Body.
	target	string	The email invitation URL will redirect to target after confirming the person's email address. The redirect page should contain a prominent link to the squad settings page at http://www.groundcrew.us/settings/{squad_id} so that new members may enter further details, such as location and mobile number. Defaults to Groundcrew settings page.

[edit] Example

curl -F "api_key={key}&groups={organizer}&emails={joe@groundcrew.us,noah@groundcrew.us}" \
 http://wwww.groundcrew.us/api/squad/{squad_id}/people/invite

[edit] Email Forms

The default email form depends on which group(s) are being assigned, but looks roughly like the following:

[edit] Default email to agents

[edit] Subject

You've been invited to join {squad_name}, a Groundcrew squad!

[edit] Body

If the msg parameter is provided, it will be substituted for the text between {MSG START} and {MSG END}.

{MSG START}
Hi, you've been invited to join {squad_name}, a Groundcrew squad.

Groundcrew gives you assignments by text message on your phone from the 
organizations you care about. You'll be invited to take part in group actions, 
but you can stop Groundcrew texts at any time after signup.
{MSG END}

To confirm your invitation and set your mobile phone number, click here:


  {invite_url / target}

Thanks,

Team Groundcrew and {squad_name}
http://groundcrew.us
+1.413.250.8007