v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Site Users

Send invite to site user.

For a given site and send an invite for site user to join. The invite will expire in 7 days.

post/v1/sites/{id}/users

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

namestring required

Name of the site user

emailstring required

Email address of the site user

Example request

{
  "name": "Ms. Site User",
  "email": "siteuser@rocket.net"
}

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "success": true,
    "id": 1234567890
  }
}