Skip to main content

Send Invitations

Uses the API to send an email that contains an invitation urging the user to sign up on Gigapipe and join the organization. When a user signs up using the invitation, their role inside the company will automatically be set up to 'Admin'. Learn more about roles

Send an invitation​

Provide the API with an email and your organization name to get an invite sent to whomever you want.

curl -X 'POST' \
  'https://api.gigapipe.com/v1/invites' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your_access_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "martha@lamborgini.com",
  "organization_name": "Lamborgini"
}'
# Payload response ::Dictionary
{
  "message": "Invite sent to <martha@lamborgini.com>"
}

The invite payload​

Attributes​

email  ::String

The email you want to invite to your organization

organization  ::String

The name of your organization

Response​

Attributes​

message  ::String

A basic response message