Send an invitation to a new hub user

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Content-Type: application/json
{
  "email": "vbot@example.com",
  "message": "Join the hot vbot hotbot hub!"
}

RESPONSE
201 (Created)
{
  "email": "vbot@example.com",
  "id": 71,
  "invitation_accepted": false,
  "created_at": 1400695130,
  "updated_at": 1400695130
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

email
required

email used to sign in

Validations:

  • Must be a String

message
optional

Optional custom message you wish to send to the invitee

Validations:

  • Must be a String