Skip to main content
POST
/
api
/
v3
/
sites
/
{site_uuid}
/
teams
/
invite
Create an invite
curl --request POST \
  --url https://app.plugchoice.com/api/v3/sites/{site_uuid}/teams/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "[email protected]",
  "transfer_ownership": true,
  "data_access": true,
  "data_access_expires_at": "2051-12-13",
  "can_access_all_assets": true,
  "accessible_assets": null
}'
{
  "message": "Invite created successfully",
  "invite": {
    "id": 1,
    "email": "[email protected]",
    "token": "abc123",
    "expires_at": "2024-01-01T00:00:00Z"
  },
  "invite_token": "abc123",
  "invite_links": {
    "web": "https://app.volttime.com/site/invite/accept?site_id=1&[email protected]&token=abc123",
    "deep_link": "pluggy://invite/abc123"
  }
}

Authorizations

​
Authorization
string
header
required

See the documentation for more information.

Path Parameters

​
site_uuid
string
required

Body

application/json
​
email
string
required

Must be a valid email address. Must not be greater than 255 characters.

Example:

"[email protected]"

​
transfer_ownership
boolean | null
Example:

true

​
data_access
boolean | null
Example:

true

​
data_access_expires_at
string | null

Must be a valid date. Must be a date after <code>today</code>.

Example:

"2051-12-13"

​
can_access_all_assets
boolean | null
Example:

true

​
accessible_assets
array

This field is required when <code>can_access_all_assets</code> is <code>false</code>.

Example:

null

Response

201 - application/json

Invite created successfully

​
message
string
Example:

"Invite created successfully"

​
invite
object
​
invite_token
string
Example:

"abc123"

​
invite_links
object