Invite guest
Invite a guest to one site from People in the site settings.
POST https://cotlet.dev/api/v1/plausible/guest/invite
write Confirm
Plausible emails the invitation. The guest must sign up or log in with that exact address and accept it within 48 hours. Guests count toward your team member limit, and pending invitations count too. Only an Owner or Admin of the team can invite. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| site string required | string | Domain of the site as the Sites page lists it, e.g. acme-shop.example. |
| email string required | string | Email address of the guest. |
| role string required | string | guest_viewer (dashboard only) or guest_editor (dashboard and site settings). |
Request
curl -X POST https://cotlet.dev/api/v1/plausible/guest/invite \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"site":"site","email":"jane@example.com","role":"role"}'result = client.call("plausible", "invite_guest", {"site":"site","email":"jane@example.com","role":"role"})const result = await cotlet.call('plausible', 'invite_guest', {"site":"site","email":"jane@example.com","role":"role"});cotlet call plausible invite_guest --data '{"site":"site","email":"jane@example.com","role":"role"}'Example response
{
"site": "acme-shop.example",
"email": "nora@client.example",
"role": "Guest Viewer",
"status": "invited"
}