Invite Team

POST /v3/sites/{site}/teams/invite

Invite Team

cURL

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
    }
  ]
}
'

200

{
  "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.

Show asset object

accessible_assets[].asset_type · string · required

The asset type class name.

accessible_assets[].asset_id · integer · required

The numeric ID of the asset.

Response

message · string

A confirmation message indicating the invite was created successfully.

invite · object

The created invitation object.

Show invite

id · integer

The numeric ID of the invitation.

site_id · integer

The ID of the location.

email · string

The email address the invitation was sent to.

expires_at · string

ISO 8601 timestamp of when the invitation expires.

transfer_ownership · boolean

Whether ownership will be transferred upon acceptance.

data_access · boolean

Whether data access will be granted upon acceptance.

data_access_expires_at · string

ISO 8601 timestamp of when data access expires. May be null.

can_access_all_assets · boolean

Whether the team will have access to all assets.

accessible_assets · array

The list of specific accessible assets, if limited.

created_at · string

ISO 8601 timestamp of when the invitation was created.

updated_at · string

ISO 8601 timestamp of when the invitation was last updated.

invite_token · string

The invitation token used for acceptance.

invite_links · object

Links for accepting the invitation.

Show invite_links

web · string

The web URL to accept the invitation.

deep_link · string

The deep link URL for mobile app acceptance.