Skip to main content
POST
/
v3
/
sites
/
{site}
/
teams
/
invite
Invite Team
curl --request POST \
  --url https://app.plugchoice.com/api/v3/sites/{site}/teams/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "transfer_ownership": true,
  "data_access": true,
  "data_access_expires_at": "<string>",
  "can_access_all_assets": true,
  "accessible_assets": [
    {
      "accessible_assets[].asset_type": "<string>",
      "accessible_assets[].asset_id": 123
    }
  ]
}
'
{
  "message": "<string>",
  "invite": {
    "id": 123,
    "site_id": 123,
    "email": "<string>",
    "expires_at": "<string>",
    "transfer_ownership": true,
    "data_access": true,
    "data_access_expires_at": "<string>",
    "can_access_all_assets": true,
    "accessible_assets": [
      {}
    ],
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "invite_token": "<string>",
  "invite_links": {
    "web": "<string>",
    "deep_link": "<string>"
  }
}
Invites a team to the specified location by email. The invited user will receive an email with a link to accept the invitation. Rate limited to 5 requests per minute.
​
site
string
required
The UUID of the location.
​
email
string
required
The email address of the user to invite. Maximum 255 characters.
​
transfer_ownership
boolean
Whether to transfer location ownership to the invited team upon acceptance.
​
data_access
boolean
Whether to grant sensitive data access to the invited team.
​
data_access_expires_at
string
ISO 8601 date for when the data access expires. Must be a future date.
​
can_access_all_assets
boolean
Whether the invited team can access all assets on the location.
​
accessible_assets
array
An array of specific assets the team can access. Required when can_access_all_assets is false.

​
Response

​
message
string
A confirmation message indicating the invite was created successfully.
​
invite
object
The created invitation object.
​
invite_token
string
The invitation token used for acceptance.
​
invite_links
object
Links for accepting the invitation.